diff --git a/Readme.md b/Readme.md index c7104093e..b343d6473 100644 --- a/Readme.md +++ b/Readme.md @@ -26,7 +26,7 @@ You can use go modules to add our library to your project ### Go module ```bash -go get github.com/adyen/adyen-go-api-library/v3 +go get github.com/adyen/adyen-go-api-library/v4 ``` ## Documentation @@ -40,9 +40,9 @@ go get github.com/adyen/adyen-go-api-library/v3 ```go import ( - "github.com/adyen/adyen-go-api-library/v3/src/checkout" - "github.com/adyen/adyen-go-api-library/v3/src/common" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/checkout" + "github.com/adyen/adyen-go-api-library/v4/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" ) client := adyen.NewClient(&common.Config{ @@ -59,9 +59,9 @@ res, httpRes, err := client.Checkout.PaymentMethods(&checkout.PaymentMethodsRequ ```go import ( - "github.com/adyen/adyen-go-api-library/v3/src/checkout" - "github.com/adyen/adyen-go-api-library/v3/src/common" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/checkout" + "github.com/adyen/adyen-go-api-library/v4/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" ) client := adyen.NewClient(&common.Config{ @@ -79,9 +79,9 @@ res, httpRes, err := client.Checkout.PaymentMethods(&checkout.PaymentMethodsRequ ```go import ( - "github.com/adyen/adyen-go-api-library/v3/src/recurring" - "github.com/adyen/adyen-go-api-library/v3/src/common" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/recurring" + "github.com/adyen/adyen-go-api-library/v4/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" ) client := adyen.NewClient(&common.Config{ @@ -104,8 +104,8 @@ res, httpRes, err := client.Recurring.ListRecurringDetails(&recurring.RecurringD ```go import ( - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) client := adyen.NewClient(&common.Config{ @@ -120,9 +120,9 @@ notification, err := client.Notification.HandleNotificationRequest(jsonRequestSt ```go import ( - "github.com/adyen/adyen-go-api-library/v3/src/common" - "github.com/adyen/adyen-go-api-library/v3/src/checkout" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/checkout" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" ) client := adyen.NewClient(&common.Config{ diff --git a/go.mod b/go.mod index 8e05d1a4c..6198971b7 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/adyen/adyen-go-api-library/v3 +module github.com/adyen/adyen-go-api-library/v4 go 1.13 diff --git a/main.go b/main.go index 1306722b9..720bc76d9 100644 --- a/main.go +++ b/main.go @@ -9,8 +9,8 @@ package main import ( "fmt" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) func main() { diff --git a/main_test.go b/main_test.go index d51c6f070..49943e2f1 100644 --- a/main_test.go +++ b/main_test.go @@ -10,9 +10,9 @@ import ( "strings" "testing" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/checkout" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/checkout" + "github.com/adyen/adyen-go-api-library/v4/src/common" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" @@ -29,7 +29,7 @@ func Test_main(t *testing.T) { require.NotNil(t, client.Checkout.Client) require.NotNil(t, client.Checkout.Client.Cfg) require.Equal(t, common.TestEnv, client.Checkout.Client.Cfg.Environment) - assert.Equal(t, "https://checkout-test.adyen.com/checkout/v52", client.Checkout.BasePath()) + assert.Equal(t, "https://checkout-test.adyen.com/checkout/v65", client.Checkout.BasePath()) t.Run("Create a API request that should fail", func(t *testing.T) { res, httpRes, err := client.Checkout.PaymentMethods(&checkout.PaymentMethodsRequest{}) diff --git a/src/adyen/api.go b/src/adyen/api.go index 27bcb3d5e..6709b4c94 100644 --- a/src/adyen/api.go +++ b/src/adyen/api.go @@ -10,18 +10,18 @@ import ( "fmt" "net/http" - binlookup "github.com/adyen/adyen-go-api-library/v3/src/binlookup" - checkout "github.com/adyen/adyen-go-api-library/v3/src/checkout" - checkoututility "github.com/adyen/adyen-go-api-library/v3/src/checkoututility" - common "github.com/adyen/adyen-go-api-library/v3/src/common" - notification "github.com/adyen/adyen-go-api-library/v3/src/notification" - payments "github.com/adyen/adyen-go-api-library/v3/src/payments" - payouts "github.com/adyen/adyen-go-api-library/v3/src/payouts" - platformsaccount "github.com/adyen/adyen-go-api-library/v3/src/platformsaccount" - platformsfund "github.com/adyen/adyen-go-api-library/v3/src/platformsfund" - platformshostedonboardingpage "github.com/adyen/adyen-go-api-library/v3/src/platformshostedonboardingpage" - platformsnotificationconfiguration "github.com/adyen/adyen-go-api-library/v3/src/platformsnotificationconfiguration" - recurring "github.com/adyen/adyen-go-api-library/v3/src/recurring" + binlookup "github.com/adyen/adyen-go-api-library/v4/src/binlookup" + checkout "github.com/adyen/adyen-go-api-library/v4/src/checkout" + common "github.com/adyen/adyen-go-api-library/v4/src/common" + disputes "github.com/adyen/adyen-go-api-library/v4/src/disputes" + notification "github.com/adyen/adyen-go-api-library/v4/src/notification" + payments "github.com/adyen/adyen-go-api-library/v4/src/payments" + payouts "github.com/adyen/adyen-go-api-library/v4/src/payouts" + platformsaccount "github.com/adyen/adyen-go-api-library/v4/src/platformsaccount" + platformsfund "github.com/adyen/adyen-go-api-library/v4/src/platformsfund" + platformshostedonboardingpage "github.com/adyen/adyen-go-api-library/v4/src/platformshostedonboardingpage" + platformsnotificationconfiguration "github.com/adyen/adyen-go-api-library/v4/src/platformsnotificationconfiguration" + recurring "github.com/adyen/adyen-go-api-library/v4/src/recurring" ) // Constants used for the client API @@ -31,21 +31,23 @@ const ( EndpointLiveSuffix = "-pal-live.adyenpayments.com" MarketpayEndpointTest = "https://cal-test.adyen.com/cal/services" MarketpayEndpointLive = "https://cal-live.adyen.com/cal/services" - MarketpayAccountAPIVersion = "v5" - MarketpayFundAPIVersion = "v5" - MarketpayNotificationAPIVersion = "v5" - MarketpayHopAPIVersion = "v1" - APIVersion = "v52" + MarketpayAccountAPIVersion = "v6" + MarketpayFundAPIVersion = "v6" + MarketpayNotificationAPIVersion = "v6" + MarketpayHopAPIVersion = "v6" + APIVersion = "v64" RecurringAPIVersion = "v49" CheckoutEndpointTest = "https://checkout-test.adyen.com/checkout" CheckoutEndpointLiveSuffix = "-checkout-live.adyenpayments.com/checkout" - CheckoutAPIVersion = "v52" + CheckoutAPIVersion = "v65" BinLookupPalSuffix = "/pal/servlet/BinLookup/" BinLookupAPIVersion = "v50" - CheckoutUtilityAPIVersion = "v1" TerminalAPIEndpointTest = "https://terminal-api-test.adyen.com" TerminalAPIEndpointLive = "https://terminal-api-live.adyen.com" EndpointProtocol = "https://" + DisputesEndpointTest = "https://ca-test.adyen.com/ca/services/DisputeService" + DisputesEndpointLive = "https://ca-live.adyen.com/ca/services/DisputeService" + DisputesAPIVersion = "v30" ) // APIClient manages communication with the Adyen Checkout API API v51 @@ -54,7 +56,6 @@ type APIClient struct { client *common.Client // API Services Checkout *checkout.Checkout - CheckoutUtility *checkoututility.CheckoutUtility Payments *payments.Payments Payouts *payouts.Payouts Recurring *recurring.Recurring @@ -64,6 +65,7 @@ type APIClient struct { PlatformsFund *platformsfund.PlatformsFund PlatformsHostedOnboardingPage *platformshostedonboardingpage.PlatformsHostedOnboardingPage PlatformsNotificationConfiguration *platformsnotificationconfiguration.PlatformsNotificationConfiguration + Disputes *disputes.Disputes } // NewClient creates a new API client. Requires Config object. @@ -155,12 +157,6 @@ func NewClient(cfg *common.Config) *APIClient { return fmt.Sprintf("%s/%s", c.client.Cfg.CheckoutEndpoint, CheckoutAPIVersion) }, } - c.CheckoutUtility = &checkoututility.CheckoutUtility{ - Client: c.client, - BasePath: func() string { - return fmt.Sprintf("%s/%s", c.client.Cfg.CheckoutEndpoint, CheckoutUtilityAPIVersion) - }, - } c.Payments = &payments.Payments{ Client: c.client, BasePath: func() string { @@ -217,6 +213,13 @@ func NewClient(cfg *common.Config) *APIClient { }, } + c.Disputes = &disputes.Disputes{ + Client: c.client, + BasePath: func() string { + return fmt.Sprintf("%s/%s", c.client.Cfg.DisputesEndpoint, DisputesAPIVersion) + }, + } + return c } @@ -230,6 +233,7 @@ func (c *APIClient) SetEnvironment(env common.Environment, liveEndpointURLPrefix if env == common.LiveEnv { c.client.Cfg.Environment = env c.client.Cfg.MarketPayEndpoint = MarketpayEndpointLive + c.client.Cfg.DisputesEndpoint = DisputesEndpointLive if liveEndpointURLPrefix != "" { c.client.Cfg.Endpoint = EndpointProtocol + liveEndpointURLPrefix + EndpointLiveSuffix c.client.Cfg.CheckoutEndpoint = EndpointProtocol + liveEndpointURLPrefix + CheckoutEndpointLiveSuffix @@ -244,6 +248,7 @@ func (c *APIClient) SetEnvironment(env common.Environment, liveEndpointURLPrefix c.client.Cfg.MarketPayEndpoint = MarketpayEndpointTest c.client.Cfg.CheckoutEndpoint = CheckoutEndpointTest c.client.Cfg.TerminalApiCloudEndpoint = TerminalAPIEndpointTest + c.client.Cfg.DisputesEndpoint = DisputesEndpointTest } } diff --git a/src/adyen/api_test.go b/src/adyen/api_test.go index 17c477e24..c31c26897 100644 --- a/src/adyen/api_test.go +++ b/src/adyen/api_test.go @@ -12,9 +12,9 @@ import ( "testing" "time" - "github.com/adyen/adyen-go-api-library/v3/src/checkout" - "github.com/adyen/adyen-go-api-library/v3/src/common" - "github.com/adyen/adyen-go-api-library/v3/src/recurring" + "github.com/adyen/adyen-go-api-library/v4/src/checkout" + "github.com/adyen/adyen-go-api-library/v4/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/recurring" "github.com/joho/godotenv" "github.com/stretchr/testify/assert" @@ -32,9 +32,7 @@ func Test_api(t *testing.T) { require.NotNil(t, client.client.Cfg) require.NotNil(t, client.client.Cfg.HTTPClient) require.NotNil(t, client.Checkout) - require.NotNil(t, client.CheckoutUtility) - assert.Equal(t, "https://checkout-test.adyen.com/checkout/v52", client.Checkout.BasePath()) - assert.Equal(t, "https://checkout-test.adyen.com/checkout/v1", client.CheckoutUtility.BasePath()) + assert.Equal(t, "https://checkout-test.adyen.com/checkout/v65", client.Checkout.BasePath()) t.Run("Create a API request that should fail", func(t *testing.T) { res, httpRes, err := client.Checkout.PaymentMethods(&checkout.PaymentMethodsRequest{}) diff --git a/src/binlookup/api/openapi.yaml b/src/binlookup/api/openapi.yaml index a27e0813d..113f8bc31 100644 --- a/src/binlookup/api/openapi.yaml +++ b/src/binlookup/api/openapi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.0.3 info: contact: email: support@adyen.com @@ -18,6 +18,7 @@ paths: Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/checkout/3d-secure/native-3ds2). + operationId: post-get3dsAvailability requestBody: content: application/json: @@ -32,14 +33,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Checks 3D Secure availability. x-groupName: General x-sortIndex: 0 @@ -51,6 +52,7 @@ paths: To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter. + operationId: post-getCostEstimate requestBody: content: application/json: @@ -65,14 +67,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Gets a cost estimate. x-groupName: General x-sortIndex: 0 @@ -89,10 +91,7 @@ components: minLength: 3 type: string value: - description: |- - The payable amount that can be charged for the transaction. - - The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). format: int64 type: integer required: @@ -202,10 +201,10 @@ components: type: integer CostEstimateRequest: example: - encryptedCard: encryptedCard amount: currency: currency value: 0 + encryptedCardNumber: encryptedCardNumber merchantAccount: merchantAccount recurring: recurringExpiry: 2000-01-23T04:56:07.000+00:00 @@ -234,15 +233,15 @@ components: description: |- The card number (4-19 characters) for PCI compliant use cases. Do not use any separators. - > Either the `cardNumber` or `encryptedCard` field must be provided in a payment request. + > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request. maxLength: 19 minLength: 4 type: string - encryptedCard: + encryptedCardNumber: description: |- Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the `encryptedCardNumber` field. - > Either the `cardNumber` or `encryptedCard` field must be provided in a payment request. + > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request. type: string merchantAccount: description: The merchant account identifier you want to process the (transaction) @@ -275,7 +274,7 @@ components: type: string shopperReference: description: |- - The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). + Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. type: string required: @@ -424,11 +423,14 @@ components: - brands merchantAccount: merchantAccount recurringDetailReference: recurringDetailReference - additionalData: '{}' + additionalData: + key: additionalData cardNumber: cardNumber shopperReference: shopperReference properties: additionalData: + additionalProperties: + type: string description: |- This field contains additional data, which may be required for a particular request. @@ -453,7 +455,6 @@ components: user ID or account ID). type: string required: - - brands - merchantAccount ThreeDSAvailabilityResponse: example: @@ -498,5 +499,13 @@ components: threeDS2supported: description: Indicator if 3D Secure 2 is supported. type: boolean + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http x-groups: - General diff --git a/src/binlookup/api_default.go b/src/binlookup/api_default.go index 59a52846a..9593e43f7 100644 --- a/src/binlookup/api_default.go +++ b/src/binlookup/api_default.go @@ -14,7 +14,7 @@ import ( _context "context" _nethttp "net/http" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // BinLookup BinLookup service diff --git a/src/binlookup/model_amount.go b/src/binlookup/model_amount.go index 1ed77bd0e..7e283092d 100644 --- a/src/binlookup/model_amount.go +++ b/src/binlookup/model_amount.go @@ -13,6 +13,6 @@ package binlookup type Amount struct { // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). Currency string `json:"currency"` - // The payable amount that can be charged for the transaction. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + // The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). Value int64 `json:"value"` } diff --git a/src/binlookup/model_cost_estimate_request.go b/src/binlookup/model_cost_estimate_request.go index 103c9f186..0a76e16c2 100644 --- a/src/binlookup/model_cost_estimate_request.go +++ b/src/binlookup/model_cost_estimate_request.go @@ -13,10 +13,10 @@ package binlookup type CostEstimateRequest struct { Amount Amount `json:"amount"` Assumptions *CostEstimateAssumptions `json:"assumptions,omitempty"` - // The card number (4-19 characters) for PCI compliant use cases. Do not use any separators. > Either the `cardNumber` or `encryptedCard` field must be provided in a payment request. + // The card number (4-19 characters) for PCI compliant use cases. Do not use any separators. > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request. CardNumber string `json:"cardNumber,omitempty"` - // Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the `encryptedCardNumber` field. > Either the `cardNumber` or `encryptedCard` field must be provided in a payment request. - EncryptedCard string `json:"encryptedCard,omitempty"` + // Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the `encryptedCardNumber` field. > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request. + EncryptedCardNumber string `json:"encryptedCardNumber,omitempty"` // The merchant account identifier you want to process the (transaction) request with. MerchantAccount string `json:"merchantAccount"` MerchantDetails *MerchantDetails `json:"merchantDetails,omitempty"` @@ -25,6 +25,6 @@ type CostEstimateRequest struct { SelectedRecurringDetailReference string `json:"selectedRecurringDetailReference,omitempty"` // Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the card holder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. ShopperInteraction string `json:"shopperInteraction,omitempty"` - // The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments. + // Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. ShopperReference string `json:"shopperReference,omitempty"` } diff --git a/src/binlookup/model_three_ds_availability_request.go b/src/binlookup/model_three_ds_availability_request.go index b60354632..faddc8ff6 100644 --- a/src/binlookup/model_three_ds_availability_request.go +++ b/src/binlookup/model_three_ds_availability_request.go @@ -9,12 +9,13 @@ */ package binlookup + // ThreeDSAvailabilityRequest struct for ThreeDSAvailabilityRequest type ThreeDSAvailabilityRequest struct { // This field contains additional data, which may be required for a particular request. The `additionalData` object consists of entries, each of which includes the key and value. AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` // List of brands. - Brands []string `json:"brands"` + Brands []string `json:"brands,omitempty"` // Card number or BIN. CardNumber string `json:"cardNumber,omitempty"` // The merchant account identifier. diff --git a/src/checkout/README.md b/src/checkout/README.md index f15c6d170..4400bee97 100644 --- a/src/checkout/README.md +++ b/src/checkout/README.md @@ -20,13 +20,13 @@ Checkout API supports versioning of its endpoints through a version suffix in th For example: ``` -https://checkout-test.adyen.com/v52/payments +https://checkout-test.adyen.com/v65/payments ``` ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 52 +- API version: 65 - Package version: 1.0.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit [https://support.adyen.com/](https://support.adyen.com/) diff --git a/src/checkout/api/openapi.yaml b/src/checkout/api/openapi.yaml index fd3ab9849..3d04c1535 100644 --- a/src/checkout/api/openapi.yaml +++ b/src/checkout/api/openapi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.0.3 info: contact: email: support@adyen.com @@ -25,20 +25,118 @@ info: For example: ``` - https://checkout-test.adyen.com/v52/payments + https://checkout-test.adyen.com/v65/payments ``` termsOfService: https://www.adyen.com/legal/terms-and-conditions title: Adyen Checkout API - version: "52" + version: "65" servers: -- url: https://checkout-test.adyen.com/v52 +- url: https://checkout-test.adyen.com/v65 paths: + /orders: + post: + description: Creates an order to be used for partial payments. Make a POST `/orders` + call before making a `/payments` call when processing payments with different + payment methods. + operationId: post-orders + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckoutCreateOrderRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CheckoutCreateOrderResponse' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Creates an order for the given amount. + x-groupName: Orders + x-sortIndex: 2 + /orders/cancel: + post: + description: Cancels an order. Cancellation of an order results in an automatic + rollback of all payments made in the order, either by canceling or refunding + the payment, depending on the type of payment method. + operationId: post-orders-cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckoutCancelOrderRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CheckoutCancelOrderResponse' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Cancels the given order. + x-groupName: Orders + x-sortIndex: 3 + /originKeys: + post: + description: "This operation takes the origin domains and returns a JSON object\ + \ containing the corresponding origin keys for the domains. \n> Instead of\ + \ using an origin key, consider [switching to a client key](https://docs.adyen.com/user-management/client-side-authentication/migrate-from-origin-key-to-client-key)\ + \ for your Web Drop-in or Web Component integration. This allows you to use\ + \ a single key for all origins, add or remove origins without generating a\ + \ new key, and detect the card type from the number entered in your payment\ + \ form. " + operationId: post-originKeys + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckoutUtilityRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CheckoutUtilityResponse' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Create originKey values for one or more merchant domains. + x-groupName: Utility + x-sortIndex: 1 /paymentLinks: post: description: |- Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/checkout/pay-by-link#create-payment-links-through-api). + operationId: post-paymentLinks requestBody: content: application/json: @@ -49,27 +147,105 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreatePaymentLinkResponse' + $ref: '#/components/schemas/PaymentLinkResource' description: OK - the request has succeeded. + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentLinkResource' + description: Created - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. "422": description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Creates a payment link. + x-groupName: Payment links + x-sortIndex: 1 + /paymentLinks/{linkId}: + get: + description: Retrieves the payment link details using the payment link `id`. + operationId: get-paymentLinks-linkId + parameters: + - description: Unique identifier of the payment link. + explode: false + in: path + name: linkId + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentLinkResource' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. "401": description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. "500": description: Internal Server Error - the server could not process the request. + summary: Retrieve a payment link. + x-groupName: Payment links + x-sortIndex: 2 + patch: + description: Updates the status of a payment link. Use this endpoint to [force + the expiry of a payment link](https://docs.adyen.com/checkout/pay-by-link#update-payment-link-status). + operationId: patch-paymentLinks-linkId + parameters: + - description: Unique identifier of the payment link. + explode: false + in: path + name: linkId + required: true + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePaymentLinkRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentLinkResource' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. "403": description: Forbidden - insufficient permissions to process the request. - summary: Creates a payment link. - x-groupName: API Integration - x-sortIndex: 8 + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Update the status of a payment link + x-groupName: Payment links + x-sortIndex: 3 /paymentMethods: post: description: |- Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week. + operationId: post-paymentMethods requestBody: content: application/json: @@ -84,16 +260,47 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. "500": description: Internal Server Error - the server could not process the request. + summary: Returns available payment methods. + x-groupName: Payments + x-sortIndex: 1 + /paymentMethods/balance: + post: + description: Retrieves the balance remaining on a shopper's gift card. To check + a gift card's balance, make a POST `/paymentMethods/balance` call and include + the gift card's details inside a `paymentMethod` object. + operationId: post-paymentMethods-balance + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CheckoutBalanceCheckResponse' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. "403": description: Forbidden - insufficient permissions to process the request. - summary: Returns available payment methods. - x-groupName: API Integration + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Returns the available balance on gift card. + x-groupName: Orders x-sortIndex: 1 /paymentSession: post: @@ -101,6 +308,7 @@ paths: Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/checkout#howitworks). + operationId: post-paymentSession requestBody: content: application/json: @@ -115,23 +323,24 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Creates a payment session. - x-groupName: SDK Integration + x-groupName: Classic Checkout SDK x-sortIndex: 1 /payments: post: description: |- - Sends payment parameters (like amount, country, and currency) together with the input details collected from the shopper. The response returns the result of the payment request: - * For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. `Authorised` or `Refused`). - * For other payment methods, you'll receive `redirectShopper` as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`. + Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request: + * For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**). + * For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`. + operationId: post-payments requestBody: content: application/json: @@ -146,16 +355,16 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Starts a transaction. - x-groupName: API Integration + x-groupName: Payments x-sortIndex: 2 /payments/details: post: @@ -165,6 +374,7 @@ paths: The exact details, which need to be sent to this endpoint, are always specified in the response of the associated `/payments` request. In addition, the endpoint can be used to verify a `payload`, which is returned after coming back from the Checkout SDK or any of the redirect based methods on the Checkout API. + operationId: post-payments-details requestBody: content: application/json: @@ -179,16 +389,16 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Submits details for a payment. - x-groupName: API Integration + x-groupName: Payments x-sortIndex: 3 /payments/result: post: @@ -196,6 +406,7 @@ paths: Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/checkout#howitworks). + operationId: post-payments-result requestBody: content: application/json: @@ -210,16 +421,16 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Verifies payment result. - x-groupName: SDK Integration + x-groupName: Classic Checkout SDK x-sortIndex: 2 components: schemas: @@ -384,98 +595,113 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string - AdditionalDataCommon: + AchDetails: properties: - authorisationType: - description: |- - Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/checkout/adjust-authorisation#authorisation-types). - - Allowed values: - * **PreAuth** – flags the payment request to be handled as a pre-authorisation. - * **FinalAuth** – flags the payment request to be handled as a final authorisation. + bankAccountNumber: + description: The bank account number (without separators). type: string - customRoutingFlag: - description: |- - Allows you to determine or override the acquirer account that should be used for the transaction. - - If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. - - To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new). + bankLocationId: + description: The bank routing number of the account. The field value is + `nil` in most cases. type: string - networkTxReference: - description: |- - Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. - - Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. - - Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. - - Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardonFile** to ensure that the transaction is classified as MIT. + encryptedBankAccountNumber: + description: Encrypted bank account number. The bank account number (without + separators). type: string - overwriteBrand: - description: Boolean indicator that can be optionally used for performing - debit transactions on combo cards (for example, combo cards in Brazil). - This is not mandatory but we recommend that you set this to true if you - want to use the `selectedBrand` value to specify how to process the transaction. + encryptedBankLocationId: + description: Encrypted location id. The bank routing number of the account. + The field value is `nil` in most cases. type: string - RequestedTestErrorResponseCode: + ownerName: description: |- - Triggers test scenarios that allow to replicate certain communication errors. - - Allowed values: - * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. - This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. - * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. - This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response. + The name of the bank account holder. + If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: + * χ12 is converted to ch12. + * üA is converted to euA. + * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. + After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: + * John17 - allowed. + * J17 - allowed. + * 171 - not allowed. + * John-7 - allowed. + > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. type: string - subMerchantID: - description: |- - This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID, which is used by schemes to identify the merchant. - - A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. - * Format: alpha-numeric. - * Fixed length: 15 characters. + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: ach + description: '**ach**' type: string + required: + - bankAccountNumber + - type AdditionalData3DSecure: properties: allow3DS2: - description: |- - This parameter indicates that you are able to process 3D Secure 2 transactions natively on your payment page. Send this field when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/checkout/3d-secure/native-3ds2), such as Components or Drop-in. Possible values: + description: | + Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/checkout/3d-secure/native-3ds2). + + > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter. + + Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration. - > This parameter only indicates your readiness to support 3D Secure 2 natively on Drop-in or Components. To specify that you want to perform 3D Secure on a transaction, use Dynamic 3D Secure or send the executeThreeD parameter. type: string executeThreeD: - description: |- - This parameter indicates if you want to perform 3D Secure authentication on a transaction or not. Allowed values: + description: | + Indicates if you want to perform 3D Secure authentication on a transaction. + + > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure. + + Possible values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. - > Alternatively, you can also use Dynamic 3D Secure to configure rules for applying 3D Secure. type: string mpiImplementationType: description: In case of Secure+, this field must be set to **CUPSecurePlus**. type: string scaExemption: - description: "Indicates the [exemption type](https://docs-admin.is.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ - \ that you want to request for the transaction. Possible values:\n* **lowValue**\ - \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " + description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ + \ that you want to request for the transaction.\n\n Possible values:\n\ + * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ + \ **transactionRiskAnalysis** " + type: string + threeDSVersion: + description: "Indicates your preference for the 3D Secure version. \n> If\ + \ you use this parameter, you override the checks from Adyen's Authentication\ + \ Engine. We recommend to use this field only if you have an extensive\ + \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ + \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ + \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ + \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ + \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ + \ in the `ARes`, we will apply the fallback policy configured in your\ + \ account. For example, if the configuration is to fall back to 3D Secure\ + \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ + \ the BIN is not enrolled, you will receive an error.\n\n" type: string AdditionalDataAirline: properties: - airline.passenger_name: + airline.agency_invoice_number: description: |- - Passenger name, initials, and a title. - * Format: last name + first name or initials + title. - * Example: *FLYER / MARY MS*. + Reference number for the invoice, issued by the agency. * minLength: 1 - * maxLength: 49 + * maxLength: 6 type: string - airline.computerized_reservation_system: + airline.agency_plan_name: description: |- - The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. - * Format: alphanumeric. - * minLength: 4 - * maxLength: 4 + 2-letter agency plan identifier; alphabetical. + * minLength: 2 + * maxLength: 2 type: string airline.airline_code: description: |- @@ -485,32 +711,6 @@ components: * minLength: 3 * maxLength: 3 type: string - airline.ticket_number: - description: |- - The ticket's unique identifier. - * minLength: 1 - * maxLength: 150 - type: string - airline.flight_date: - description: |- - Flight departure date. Local time `(HH:mm)` is optional. - * Date format: `yyyy-MM-dd` - * Date and time format: `yyyy-MM-dd HH:mm` - * minLength: 10 - * maxLength: 16 - type: string - airline.customer_reference_number: - description: |- - Reference number; alphanumeric. - * minLength: 0 - * maxLength: 20 - type: string - airline.ticket_issue_address: - description: |- - Address of the place/agency that issued the ticket. - * minLength: 0 - * maxLength: 16 - type: string airline.airline_designator_code: description: |- [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier. @@ -519,30 +719,6 @@ components: * minLength: 2 * maxLength: 2 type: string - airline.travel_agency_code: - description: |- - IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies. - * minLength: 1 - * maxLength: 8 - type: string - airline.travel_agency_name: - description: |- - The name of the travel agency. - * minLength: 1 - * maxLength: 25 - type: string - airline.agency_plan_name: - description: |- - 2-letter agency plan identifier; alphabetical. - * minLength: 2 - * maxLength: 2 - type: string - airline.agency_invoice_number: - description: |- - Reference number for the invoice, issued by the agency. - * minLength: 1 - * maxLength: 6 - type: string airline.boarding_fee: description: |- Chargeable amount for boarding the plane. @@ -550,6 +726,19 @@ components: * minLength: 1 * maxLength: 18 type: string + airline.computerized_reservation_system: + description: |- + The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. + * Format: alphanumeric. + * minLength: 4 + * maxLength: 4 + type: string + airline.customer_reference_number: + description: |- + Reference number; alphanumeric. + * minLength: 0 + * maxLength: 20 + type: string airline.document_type: description: |- Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements. @@ -558,20 +747,13 @@ components: * minLength: 2 * maxLength: 2 type: string - airline.leg.depart_airport: - description: |- - Alphabetical identifier of the departure airport. - This field is required if the airline data includes leg details. - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. - * Example: Amsterdam = AMS - * minLength: 3 - * maxLength: 3 - type: string - airline.leg.flight_number: + airline.flight_date: description: |- - The flight identifier. - * minLength: 1 - * maxLength: 5 + Flight departure date. Local time `(HH:mm)` is optional. + * Date format: `yyyy-MM-dd` + * Date and time format: `yyyy-MM-dd HH:mm` + * minLength: 10 + * maxLength: 16 type: string airline.leg.carrier_code: description: |- @@ -582,12 +764,6 @@ components: * minLength: 2 * maxLength: 2 type: string - airline.leg.fare_base_code: - description: |- - [Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric. - * minLength: 1 - * maxLength: 7 - type: string airline.leg.class_of_travel: description: |- 1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently: @@ -600,15 +776,24 @@ components: * minLength: 1 * maxLength: 1 type: string - airline.leg.stop_over_code: + airline.leg.date_of_travel: + description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ + * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" + type: string + airline.leg.depart_airport: description: |- - 1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed: - * O: Stopover allowed - * X: Stopover not allowed - - Limitations: + Alphabetical identifier of the departure airport. + This field is required if the airline data includes leg details. + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. + * Example: Amsterdam = AMS + * minLength: 3 + * maxLength: 3 + type: string + airline.leg.depart_tax: + description: |- + [Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). * minLength: 1 - * maxLength: 1 + * maxLength: 12 type: string airline.leg.destination_code: description: |- @@ -619,15 +804,35 @@ components: * minLength: 3 * maxLength: 3 type: string - airline.leg.date_of_travel: - description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ - * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" + airline.leg.fare_base_code: + description: |- + [Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric. + * minLength: 1 + * maxLength: 7 type: string - airline.leg.depart_tax: + airline.leg.flight_number: description: |- - [Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + The flight identifier. * minLength: 1 - * maxLength: 12 + * maxLength: 5 + type: string + airline.leg.stop_over_code: + description: |- + 1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed: + * O: Stopover allowed + * X: Stopover not allowed + + Limitations: + * minLength: 1 + * maxLength: 1 + type: string + airline.passenger.date_of_birth: + description: |- + Date of birth of the passenger. + + Date format: `yyyy-MM-dd` + * minLength: 10 + * maxLength: 10 type: string airline.passenger.first_name: description: |- @@ -639,6 +844,12 @@ components: Passenger last name/family name. > This field is required/mandatory if the airline data includes passenger details or leg details. type: string + airline.passenger.telephone_number: + description: |- + Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs. + * minLength: 3 + * maxLength: 30 + type: string airline.passenger.traveller_type: description: |- Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS. @@ -647,75 +858,98 @@ components: * minLength: 3 * maxLength: 6 type: string - airline.passenger.telephone_number: + airline.passenger_name: description: |- - Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs. - * minLength: 3 - * maxLength: 30 + Passenger name, initials, and a title. + * Format: last name + first name or initials + title. + * Example: *FLYER / MARY MS*. + * minLength: 1 + * maxLength: 49 type: string - airline.passenger.date_of_birth: + airline.ticket_issue_address: description: |- - Date of birth of the passenger. - - Date format: `yyyy-MM-dd` - * minLength: 10 - * maxLength: 10 + Address of the place/agency that issued the ticket. + * minLength: 0 + * maxLength: 16 + type: string + airline.ticket_number: + description: |- + The ticket's unique identifier. + * minLength: 1 + * maxLength: 150 + type: string + airline.travel_agency_code: + description: |- + IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies. + * minLength: 1 + * maxLength: 8 + type: string + airline.travel_agency_name: + description: |- + The name of the travel agency. + * minLength: 1 + * maxLength: 25 type: string required: - airline.passenger_name AdditionalDataCarRental: properties: - carRental.rentalAgreementNumber: + carRental.checkOutDate: description: |- - The rental agreement number associated with this car rental. - * Format: Alphanumeric - * maxLength: 14 + Pick-up date. + * Date format: `yyyyMMdd` type: string - carRental.renterName: + carRental.customerServiceTollFreeNumber: description: |- - The name of the person renting the car. + The customer service phone number of the car rental company. * Format: Alphanumeric - * maxLength: 26 + * maxLength: 17 type: string - carRental.returnCity: + carRental.daysRented: description: |- - The city where the car must be returned. - * Format: Alphanumeric - * maxLength: 18 + Number of days for which the car is being rented. + * Format: Numeric + * maxLength: 19 type: string - carRental.returnStateProvince: + carRental.fuelCharges: description: |- - The state or province where the car must be returned. - * Format: Alphanumeric - * maxLength: 3 + Any fuel charges associated with the rental. + * Format: Numeric + * maxLength: 12 type: string - carRental.returnCountry: + carRental.insuranceCharges: description: |- - The country where the car must be returned. - * Format: Alphanumeric - * maxLength: 2 + Any insurance charges associated with the rental. + * Format: Numeric + * maxLength: 12 type: string - carRental.returnLocationId: + carRental.locationCity: description: |- - Agency code, phone number, or address abbreviation + The city from which the car is rented. * Format: Alphanumeric - * maxLength: 10 + * maxLength: 18 type: string - carRental.returnDate: + carRental.locationCountry: description: |- - The last date to return the car by. - * Date format: `yyyyMMdd` + The country from which the car is rented. + * Format: Alphanumeric + * maxLength: 2 type: string - carRental.checkOutDate: + carRental.locationStateProvince: description: |- - Pick-up date. - * Date format: `yyyyMMdd` + The state or province from where the car is rented. + * Format: Alphanumeric + * maxLength: 3 type: string - carRental.customerServiceTollFreeNumber: + carRental.noShowIndicator: description: |- - The customer service phone number of the car rental company. - * Format: Alphanumeric - * maxLength: 17 + Indicates if the customer was a "no-show" (neither keeps nor cancels their booking). + * Y - Customer was a no show. + * N - Not applicable. + type: string + carRental.oneWayDropOffCharges: + description: Charge associated with not returning a vehicle to the original + rental location. type: string carRental.rate: description: |- @@ -729,42 +963,66 @@ components: * D - Daily rate. * W - Weekly rate. type: string - carRental.locationCity: + carRental.rentalAgreementNumber: description: |- - The location from which the car is rented. + The rental agreement number associated with this car rental. * Format: Alphanumeric - * maxLength: 18 + * maxLength: 9 type: string - carRental.locationStateProvince: + carRental.rentalClassId: description: |- - Pick-up date. - * Date format: `yyyyMMdd` + Daily rental rate. + * Format: Alphanumeric + * maxLength: 12 type: string - carRental.locationCountry: + carRental.renterName: description: |- - The customer service phone number of the car rental company. + The name of the person renting the car. * Format: Alphanumeric - * maxLength: 17 + * maxLength: 26 type: string - carRental.rentalClassId: + carRental.returnCity: description: |- - Daily rental rate. + The city where the car must be returned. * Format: Alphanumeric - * maxLength: 12 + * maxLength: 18 type: string - carRental.daysRented: + carRental.returnCountry: description: |- - Specifies whether the given rate is applied daily or weekly. - * D - Daily rate. - * W - Weekly rate. + The country where the car must be returned. + * Format: Alphanumeric + * maxLength: 2 + type: string + carRental.returnDate: + description: |- + The last date to return the car by. + * Date format: `yyyyMMdd` + type: string + carRental.returnLocationId: + description: |- + Agency code, phone number, or address abbreviation + * Format: Alphanumeric + * maxLength: 10 + type: string + carRental.returnStateProvince: + description: |- + The state or province where the car must be returned. + * Format: Alphanumeric + * maxLength: 3 type: string carRental.taxExemptIndicator: description: |- Indicates whether the goods or services were tax-exempt, or tax was not collected. Values: - * 0 - Tax was not collected - * 1 - Goods or services were tax exempt + * Y - Goods or services were tax exempt + * N - Tax was not collected + type: string + travelEntertainmentAuthData.duration: + description: |- + Number of nights. This should be included in the auth message. + * Format: Numeric + * maxLength: 2 type: string travelEntertainmentAuthData.market: description: |- @@ -772,71 +1030,141 @@ components: * Format: Alphanumeric * maxLength: 1 type: string - travelEntertainmentAuthData.duration: + AdditionalDataCommon: + properties: + RequestedTestErrorResponseCode: description: |- - Number of nights. This should be included in the auth message. - * Format: Numeric - * maxLength: 2 + Triggers test scenarios that allow to replicate certain communication errors. + + Allowed values: + * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. + This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. + * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. + This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response. type: string - carRental.fuelCharges: + authorisationType: description: |- - Any fuel charges associated with the rental. - * Format: Numeric - * maxLength: 12 + Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/checkout/adjust-authorisation#authorisation-types). + + Allowed values: + * **PreAuth** – flags the payment request to be handled as a pre-authorisation. + * **FinalAuth** – flags the payment request to be handled as a final authorisation. type: string - carRental.insuranceCharges: + customRoutingFlag: description: |- - Any insurance charges associated with the rental. - * Format: Numeric - * maxLength: 12 + Allows you to determine or override the acquirer account that should be used for the transaction. + + If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. + + To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new). type: string - carRental.noShowIndicator: + industryUsage: description: |- - Indicates if the customer was a "no-show" (neither keeps nor cancels their booking). - * 0 - Not applicable. - * 1 - Customer was a no show. + In case of [asynchronous authorisation adjustment](https://docs.adyen.com/checkout/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made. + + Possible values: + + * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation. + + * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed. + enum: + - NoShow + - DelayedCharge type: string - carRental.oneWayDropOffCharges: - description: Charge associated with not returning a vehicle to the original - rental location. + networkTxReference: + description: |- + Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. + + Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. + + Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. + + Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT. + type: string + overwriteBrand: + description: Boolean indicator that can be optionally used for performing + debit transactions on combo cards (for example, combo cards in Brazil). + This is not mandatory but we recommend that you set this to true if you + want to use the `selectedBrand` value to specify how to process the transaction. + type: string + subMerchantCity: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. + * Format: alpha-numeric. + * Maximum length: 13 characters. + type: string + subMerchantCountry: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. + * Format: alpha-numeric. + * Fixed length: 3 characters. + type: string + subMerchantID: + description: |- + This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. + + A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. + * Format: alpha-numeric. + * Fixed length: 15 characters. + type: string + subMerchantName: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. + * Format: alpha-numeric. + * Maximum length: 22 characters. + type: string + subMerchantPostalCode: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. + * Format: alpha-numeric. + * Maximum length: 10 characters. + type: string + subMerchantState: + description: |- + This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. + * Format: alpha-numeric. + * Maximum length: 3 characters. + type: string + subMerchantStreet: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. + * Format: alpha-numeric. + * Maximum length: 60 characters. + type: string + subMerchantTaxId: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. + * Format: alpha-numeric. + * Fixed length: 11 or 14 characters. type: string AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: description: |- Customer code, if supplied by a customer. + Encoding: ASCII. + Max length: 25 characters. - > Required for Level 2 and Level 3 data. - type: string - enhancedSchemeData.totalTaxAmount: - description: |- - Total tax amount, in minor units. - For example, 2000 means USD 20.00. - Max length: 12 characters. > Required for Level 2 and Level 3 data. - type: number - enhancedSchemeData.freightAmount: + type: string + enhancedSchemeData.destinationCountryCode: description: |- - Shipping amount, in minor units. + Destination country code. - For example, 2000 means USD 20.00. - Max length: 12 characters. - type: number - enhancedSchemeData.dutyAmount: - description: |- - Duty amount, in minor units. + Encoding: ASCII. - For example, 2000 means USD 20.00. - Max length: 12 characters. - type: number + Max length: 3 characters. + type: string enhancedSchemeData.destinationPostalCode: description: |- The postal code of a destination address. Encoding: ASCII. + Max length: 10 characters. + > Required for American Express. type: string enhancedSchemeData.destinationStateProvinceCode: @@ -845,84 +1173,113 @@ components: Encoding: ASCII.Max length: 3 characters. type: string - enhancedSchemeData.shipFromPostalCode: + enhancedSchemeData.dutyAmount: description: |- - The postal code of a "ship-from" address. + Duty amount, in minor units. - Encoding: ASCII. - Max length: 10 characters. - type: string - enhancedSchemeData.destinationCountryCode: - description: |- - Destination country code. + For example, 2000 means USD 20.00. - Encoding: ASCII. - Max length: 3 characters. + Max length: 12 characters. type: string - enhancedSchemeData.orderDate: + enhancedSchemeData.freightAmount: description: |- - Order date. - * Format: `ddMMyy` + Shipping amount, in minor units. - Encoding: ASCII. - Max length: 6 characters. + For example, 2000 means USD 20.00. + + Max length: 12 characters. type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: |- Item commodity code. + Encoding: ASCII. + Max length: 12 characters. type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: |- Item description. + Encoding: ASCII. + Max length: 26 characters. type: string + enhancedSchemeData.itemDetailLine[itemNr].discountAmount: + description: |- + Discount amount, in minor units. + + For example, 2000 means USD 20.00. + + Max length: 12 characters. + type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: |- Product code. + Encoding: ASCII. + Max length: 12 characters. type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: |- Quantity, specified as an integer value. + Value must be greater than 0. + + Max length: 12 characters. + type: string + enhancedSchemeData.itemDetailLine[itemNr].totalAmount: + description: |- + Total amount, in minor units. + + For example, 2000 means USD 20.00. + Max length: 12 characters. - type: number + type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: |- Item unit of measurement. + Encoding: ASCII. + Max length: 3 characters. type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: |- Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). + Max length: 12 characters. - type: number - enhancedSchemeData.itemDetailLine[itemNr].discountAmount: + type: string + enhancedSchemeData.orderDate: description: |- - Discount amount, in minor units. + Order date. + * Format: `ddMMyy` - For example, 2000 means USD 20.00. - Max length: 12 characters. - type: number - enhancedSchemeData.itemDetailLine[itemNr].totalAmount: + Encoding: ASCII. + + Max length: 6 characters. + type: string + enhancedSchemeData.shipFromPostalCode: description: |- - Total amount, in minor units. + The postal code of a "ship-from" address. + + Encoding: ASCII. + + Max length: 10 characters. + type: string + enhancedSchemeData.totalTaxAmount: + description: |- + Total tax amount, in minor units. + For example, 2000 means USD 20.00. + Max length: 12 characters. - type: number + + > Required for Level 2 and Level 3 data. + type: string AdditionalDataLodging: properties: - lodging.customerServiceTollFreeNumber: - description: |- - The toll free phone number for the hotel/lodgings. - * Format: Alphanumeric - * maxLength: 17 - type: string lodging.checkInDate: description: |- The arrival date. @@ -933,60 +1290,30 @@ components: The departure date. * Date format: `yyyyMMdd` type: string - lodging.folioNumber: + lodging.customerServiceTollFreeNumber: description: |- - Card acceptor’s internal invoice or billing ID reference number. - * Format: Alphanumeric - * maxLength: 25 - type: string - lodging.propertyPhoneNumber: - description: |- - Identifies specific lodging property location by its local phone number. + The toll free phone number for the hotel/lodgings. * Format: Alphanumeric * maxLength: 17 type: string - lodging.room1.rate: - description: |- - The rate of the room. - * Format: Numeric - * maxLength: 12 - type: string - lodging.room1.tax: - description: |- - The total amount of tax to be paid. - * Format: Numeric - * maxLength: 12 - type: string - lodging.room1.numberOfNights: - description: |- - Total number of nights the room will be rented. - * Format: Numeric - * maxLength: 4 - type: string lodging.fireSafetyActIndicator: description: |- Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'. * Format: Alphabetic * maxLength: 1 type: string - travelEntertainmentAuthData.market: - description: |- - Indicates what market-specific dataset will be submitted or is being submitted. Value should be "H" for Hotel. This should be included in the auth message. - * Format: Alphanumeric - * maxLength: 1 - type: string - travelEntertainmentAuthData.duration: - description: |- - Number of nights. This should be included in the auth message. - * Format: Numeric - * maxLength: 2 - type: string lodging.folioCashAdvances: description: |- The folio cash advances. * Format: Numeric * maxLength: 12 type: string + lodging.folioNumber: + description: |- + Card acceptor’s internal invoice or billing ID reference number. + * Format: Alphanumeric + * maxLength: 25 + type: string lodging.foodBeverageCharges: description: |- Any charges for food and beverages associated with the booking. @@ -1007,9 +1334,27 @@ components: * Format: Numeric * maxLength: 12 type: string - lodging.totalTax: + lodging.propertyPhoneNumber: description: |- - Total tax amount. + Identifies specific lodging property location by its local phone number. + * Format: Alphanumeric + * maxLength: 17 + type: string + lodging.room1.numberOfNights: + description: |- + Total number of nights the room will be rented. + * Format: Numeric + * maxLength: 4 + type: string + lodging.room1.rate: + description: |- + The rate of the room. + * Format: Numeric + * maxLength: 12 + type: string + lodging.room1.tax: + description: |- + The total amount of tax to be paid. * Format: Numeric * maxLength: 12 type: string @@ -1019,14 +1364,27 @@ components: * Format: Numeric * maxLength: 12 type: string - AdditionalDataOpenInvoice: - properties: - openinvoicedata.numberOfLines: + lodging.totalTax: description: |- - The number of invoice lines included in `openinvoicedata`. + Total tax amount. + * Format: Numeric + * maxLength: 12 + type: string + travelEntertainmentAuthData.duration: + description: |- + Number of nights. This should be included in the auth message. + * Format: Numeric + * maxLength: 2 + type: string + travelEntertainmentAuthData.market: + description: |- + Indicates what market-specific dataset will be submitted or is being submitted. Value should be "H" for Hotel. This should be included in the auth message. - There needs to be at least one line, so `numberOfLines` needs to be at least 1. - type: integer + * Format: Alphanumeric + * maxLength: 1 + type: string + AdditionalDataOpenInvoice: + properties: openinvoicedata.merchantData: description: |- Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string. @@ -1039,36 +1397,42 @@ components: You can contact Klarna for the format and structure of the string. type: string - openinvoicedata.line[itemNr].currencyCode: + openinvoicedata.numberOfLines: + description: |- + The number of invoice lines included in `openinvoicedata`. + + There needs to be at least one line, so `numberOfLines` needs to be at least 1. + type: string + openinvoicedataLine[itemNr].currencyCode: description: The three-character ISO currency code. type: string - openinvoicedata.line[itemNr].description: + openinvoicedataLine[itemNr].description: description: A text description of the product the invoice line refers to. type: string - openinvoicedata.line[itemNr].itemAmount: + openinvoicedataLine[itemNr].itemAmount: description: |- The price for one item in the invoice line, represented in minor units. The due amount for the item, VAT excluded. - type: integer - openinvoicedata.line[itemNr].itemVatAmount: + type: string + openinvoicedataLine[itemNr].itemId: + description: A unique id for this item. Required for RatePay if the description + of each item is not unique. + type: string + openinvoicedataLine[itemNr].itemVatAmount: description: The VAT due for one item in the invoice line, represented in minor units. - type: integer - openinvoicedata.line[itemNr].itemVatPercentage: + type: string + openinvoicedataLine[itemNr].itemVatPercentage: description: |- The VAT percentage for one item in the invoice line, represented in minor units. For example, 19% VAT is specified as 1900. - type: integer - openinvoicedata.line[itemNr].itemId: - description: A unique id for this item. Required for RatePay if the description - of each item is not unique. type: string - openinvoicedata.line[itemNr].numberOfItems: + openinvoicedataLine[itemNr].numberOfItems: description: The number of units purchased of a specific product. - type: integer - openinvoicedata.line[itemNr].vatCategory: + type: string + openinvoicedataLine[itemNr].vatCategory: description: |- Required for AfterPay. The country-specific VAT category a product falls under. @@ -1077,27 +1441,27 @@ components: * Low * None. type: string + AdditionalDataOpi: + properties: + opi.includeTransToken: + description: |- + Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response. + + You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + type: string AdditionalDataRatepay: properties: ratepay.installmentAmount: description: Amount the customer has to pay each month. - type: integer + type: string + ratepay.interestRate: + description: Interest rate of this installment. + type: string ratepay.lastInstallmentAmount: description: Amount of the last installment. - type: integer - ratepay.interestRate: - description: Interest rate of this installment. Double - type: integer + type: string ratepay.paymentFirstday: description: Calendar day of the first payment. - type: integer - ratepaydata.invoiceId: - description: Identification name or number for the invoice, defined by the - merchant. - type: string - ratepaydata.invoiceDate: - description: Invoice date, defined by the merchant. If not included, the - invoice date is set to the delivery date. type: string ratepaydata.deliveryDate: description: Date the merchant delivered the goods to the customer. @@ -1105,61 +1469,63 @@ components: ratepaydata.dueDate: description: Date by which the customer must settle the payment. type: string + ratepaydata.invoiceDate: + description: Invoice date, defined by the merchant. If not included, the + invoice date is set to the delivery date. + type: string + ratepaydata.invoiceId: + description: Identification name or number for the invoice, defined by the + merchant. + type: string AdditionalDataRetry: properties: retry.chainAttemptNumber: description: |- The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen. + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - type: integer + type: string retry.orderAttemptNumber: description: |- The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively. + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - type: integer + type: string retry.skipRetry: description: |- The Boolean value indicating whether Adyen should skip or retry this transaction, if possible. + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - type: boolean + type: string AdditionalDataRisk: properties: riskdata.[customFieldName]: description: The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). type: string - riskdata.basket.item[itemNr].itemID: - description: ID of the item. - type: string - riskdata.basket.item[itemNr].productTitle: - description: A text description of the product the invoice line refers to. - type: string riskdata.basket.item[itemNr].amountPerItem: description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). type: string - riskdata.basket.item[itemNr].currency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.basket.item[itemNr].upc: - description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' - type: string - riskdata.basket.item[itemNr].sku: - description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' - type: string riskdata.basket.item[itemNr].brand: description: Brand of the item. type: string - riskdata.basket.item[itemNr].manufacturer: - description: Manufacturer of the item. - type: string riskdata.basket.item[itemNr].category: description: Category of the item. type: string riskdata.basket.item[itemNr].color: description: Color of the item. type: string - riskdata.basket.item[itemNr].size: - description: Size of the item. + riskdata.basket.item[itemNr].currency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.basket.item[itemNr].itemID: + description: ID of the item. + type: string + riskdata.basket.item[itemNr].manufacturer: + description: Manufacturer of the item. + type: string + riskdata.basket.item[itemNr].productTitle: + description: A text description of the product the invoice line refers to. type: string riskdata.basket.item[itemNr].quantity: description: Quantity of the item purchased. @@ -1168,12 +1534,18 @@ components: description: Email associated with the given product in the basket (usually in electronic gift cards). type: string + riskdata.basket.item[itemNr].size: + description: Size of the item. + type: string + riskdata.basket.item[itemNr].sku: + description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' + type: string + riskdata.basket.item[itemNr].upc: + description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' + type: string riskdata.promotions.promotion[itemNr].promotionCode: description: Code of the promotion. type: string - riskdata.promotions.promotion[itemNr].promotionName: - description: Name of the promotion. - type: string riskdata.promotions.promotion[itemNr].promotionDiscountAmount: description: The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -1187,8 +1559,43 @@ components: e.g. for a promotion discount of 30%, the value of the field should be 30. type: string + riskdata.promotions.promotion[itemNr].promotionName: + description: Name of the promotion. + type: string AdditionalDataRiskStandalone: properties: + PayPal.CountryCode: + description: Shopper's country of residence in the form of ISO standard + 3166 2-character country codes. + type: string + PayPal.EmailId: + description: Shopper's email. + type: string + PayPal.FirstName: + description: Shopper's first name. + type: string + PayPal.LastName: + description: Shopper's last name. + type: string + PayPal.PayerId: + description: 'Unique PayPal Customer Account identification number. Character + length and limitations: 13 single-byte alphanumeric characters.' + type: string + PayPal.Phone: + description: Shopper's phone number. + type: string + PayPal.ProtectionEligibility: + description: |- + Allowed values: + * **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. + + * **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. + + * **Ineligible** — Merchant is not protected under the Seller Protection Policy. + type: string + PayPal.TransactionId: + description: Unique transaction ID of the payment. + type: string avsResultRaw: description: 'Raw AVS result received from the acquirer, where available. Example: D' @@ -1201,7 +1608,7 @@ components: description: 'Raw CVC result received from the acquirer, where available. Example: 1' type: string - risk.token: + riskToken: description: Unique identifier or token for the shopper's card details. type: string threeDAuthenticated: @@ -1216,36 +1623,6 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string - PayPal.ProtectionEligibility: - description: |- - Allowed values: - * **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. - * **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. - * **Ineligible** — Merchant is not protected under the Seller Protection Policy. - type: string - PayPal.PayerId: - description: 'Unique PayPal Customer Account identification number. Character - length and limitations: 13 single-byte alphanumeric characters.' - type: string - PayPal.TransactionId: - description: Unique transaction ID of the payment. - type: string - PayPal.CountryCode: - description: Shopper's country of residence in the form of ISO standard - 3166 2-character country codes. - type: string - PayPal.FirstName: - description: Shopper's first name. - type: string - PayPal.LastName: - description: Shopper's last name. - type: string - PayPal.Phone: - description: Shopper's phone number. - type: string - PayPal.EmailId: - description: Shopper's email. - type: string AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -1254,12 +1631,7 @@ components: * Encoding: ASCII * maxLength: 25 type: string - enhancedSchemeData.totalTaxAmount: - description: |- - Total tax amount, in minor units. For example, 2000 means USD 20.00 - * maxLength: 12 - type: string - enhancedSchemeData.employeeName: + enhancedSchemeData.employeeName: description: |- Name or ID associated with the individual working in a temporary capacity. * maxLength: 40 @@ -1269,6 +1641,21 @@ components: Description of the job or task of the individual working in a temporary capacity. * maxLength: 40 type: string + enhancedSchemeData.regularHoursRate: + description: |- + Amount paid per regular hours worked, minor units. + * maxLength: 7 + type: string + enhancedSchemeData.regularHoursWorked: + description: |- + Amount of time worked during a normal operation for the task or job. + * maxLength: 7 + type: string + enhancedSchemeData.requestName: + description: |- + Name of the individual requesting temporary services. + * maxLength: 40 + type: string enhancedSchemeData.tempStartDate: description: |- Date for the beginning of the pay period. @@ -1281,20 +1668,10 @@ components: * Format: ddMMyy * maxLength: 6 type: string - enhancedSchemeData.requestName: - description: |- - Name of the individual requesting temporary services. - * maxLength: 40 - type: string - enhancedSchemeData.regularHoursWorked: - description: |- - Amount of time worked during a normal operation for the task or job. - * maxLength: 7 - type: string - enhancedSchemeData.regularHoursRate: + enhancedSchemeData.totalTaxAmount: description: |- - Amount paid per regular hours worked, minor units. - * maxLength: 7 + Total tax amount, in minor units. For example, 2000 means USD 20.00 + * maxLength: 12 type: string AdditionalDataWallets: properties: @@ -1317,883 +1694,1227 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string - ResponseAdditionalDataCommon: + Address: + example: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode properties: - acquirerAccountCode: - description: |- - The name of the Adyen acquirer account. - - Example: PayPalSandbox_TestAcquirer - > Only relevant for PayPal transactions. + city: + description: The name of the city. type: string - acquirerCode: + country: description: |- - The name of the acquirer processing the payment request. - - Example: TestPmmAcquirer + The two-character country code as defined in ISO-3166-1 alpha-2. For example, **US**. + > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. type: string - acquirerReference: - description: |- - The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. - - Example: 7C9N3FNBKT9 + houseNumberOrName: + description: The number or name of the house. type: string - alias: - description: |- - The Adyen alias of the card. - - Example: H167852639363479 + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. type: string - aliasType: + stateOrProvince: description: |- - The type of the card alias. - - Example: Default + State or province codes as defined in ISO 3166-2. For example, **CA** in the US or **ON** in Canada. + > Required for the US and Canada. type: string - authCode: + street: description: |- - Authorisation code: - * When the payment is authorised successfully, this field holds the authorisation code for the payment. - * When the payment is not authorised, this field is empty. - - Example: 58747 + The name of the street. + > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. type: string - authorisedAmountCurrency: - description: The currency of the authorised amount, as a three-character - [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + required: + - city + - country + - houseNumberOrName + - postalCode + - street + AmazonPayDetails: + properties: + amazonPayToken: type: string - authorisedAmountValue: - description: |- - Value of the amount authorised. - - This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + checkoutSessionId: type: string - avsResult: - description: |- - The AVS result code of the payment, which provides information about the outcome of the AVS check. - - For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs). + type: + default: amazonpay + description: '**amazonpay**' type: string - avsResultRaw: - description: |- - Raw AVS result received from the acquirer, where available. - - Example: D + required: + - type + Amount: + example: + currency: currency + value: 5 + properties: + currency: + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + maxLength: 3 + minLength: 3 type: string - bic: - description: |- - BIC of a bank account. - - Example: TESTNL01 - > Only relevant for SEPA Direct Debit transactions. + value: + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + format: int64 + type: integer + required: + - currency + - value + AndroidPayDetails: + properties: + androidPayToken: type: string - dsTransID: - description: Supported for 3D Secure 2. The unique transaction identifier - assigned by the DS to identify a single transaction. + type: + default: androidpay + description: '**androidpay**' type: string - eci: - description: |- - The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. - - Example: 02 + required: + - androidPayToken + - type + ApplePayDetails: + properties: + applePayToken: type: string - expiryDate: - description: |- - The expiry date on the card. - - Example: 6/2016 - > Returned only in case of a card payment. + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit type: string - extraCostsCurrency: - description: |- - The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. - - Example: EUR + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. type: string - extraCostsValue: - description: The value of the extra amount charged due to additional amounts - set in the skin used in the HPP payment request. The amount is in minor - units. + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. type: string - fraudCheck-[itemNr]-[FraudCheckname]: - description: The fraud score due to a particular fraud check. The fraud - check name is found in the key of the key-value pair. + type: + default: applepay + description: '**applepay**' type: string - fundingSource: + required: + - applePayToken + - type + ApplicationInfo: + example: + adyenLibrary: + name: name + version: version + merchantApplication: + name: name + version: version + adyenPaymentSource: + name: name + version: version + merchantDevice: + reference: reference + os: os + osVersion: osVersion + shopperInteractionDevice: + os: os + osVersion: osVersion + locale: locale + externalPlatform: + name: name + integrator: integrator + version: version + properties: + adyenLibrary: + $ref: '#/components/schemas/CommonField' + adyenPaymentSource: + $ref: '#/components/schemas/CommonField' + externalPlatform: + $ref: '#/components/schemas/ExternalPlatform' + merchantApplication: + $ref: '#/components/schemas/CommonField' + merchantDevice: + $ref: '#/components/schemas/MerchantDevice' + shopperInteractionDevice: + $ref: '#/components/schemas/ShopperInteractionDevice' + Avs: + example: + addressEditable: true + enabled: "yes" + properties: + addressEditable: + description: Indicates whether the shopper is allowed to modify the billing + address for the current payment request. + type: boolean + enabled: description: |- - Information regarding the funding type of the card. The possible return values are: - * CHARGE - * CREDIT - * DEBIT - * PREPAID - * PREPAID_RELOADABLE - * PREPAID_NONRELOADABLE - * DEFFERED_DEBIT - > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. + Specifies whether the shopper should enter their billing address during checkout. - For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. + Allowed values: + * yes — Perform AVS checks for every card payment. + * automatic — Perform AVS checks only when required to optimize the conversion rate. + * no — Do not perform AVS checks. + enum: + - "yes" + - "no" + - automatic type: string - fundsAvailability: - description: |- - Indicates availability of funds. - - Visa: - * "I" (fast funds are supported) - * "N" (otherwise) - - Mastercard: - * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) - * "N" (otherwise) - - > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is "Y" or "D". - type: string - inferredRefusalReason: - description: |- - Provides the more granular indication of why a transaction was refused. When a transaction fails with either "Refused", "Restricted Card", "Transaction Not Permitted", "Not supported" or "DeclinedNon Generic" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to "Not Supported". - - Possible values: - * 3D Secure Mandated - * Closed Account - * ContAuth Not Supported - * CVC Mandated - * Ecommerce Not Allowed - * Crossborder Not Supported - * Card Updated - * Low Authrate Bin - * Non-reloadable prepaid card - type: string - issuerCountry: - description: |- - The issuing country of the card based on the BIN list that Adyen maintains. - - Example: JP - type: string - mcBankNetReferenceNumber: - description: |- - The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. - > Contact Support Team to enable this field. - type: string - networkTxReference: - description: |- - Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. - - This contains either the Mastercard Trace ID or the Visa Transaction ID. - type: string - ownerName: - description: |- - The owner name of a bank account. - - Only relevant for SEPA Direct Debit transactions. - type: string - paymentAccountReference: - description: The Payment Account Reference (PAR) value links a network token - with the underlying primary account number (PAN). The PAR value consists - of 29 uppercase alphanumeric characters. - type: string - paymentMethodVariant: - description: |- - The Adyen sub-variant of the payment method used for the payment request. - - For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). - - Example: mcpro - type: string - payoutEligible: - description: |- - Indicates whether a payout is eligible or not for this card. - - Visa: - * "Y" - * "N" - - Mastercard: - * "Y" (domestic and cross-border) - * "D" (only domestic) - * "N" (no MoneySend) - * "U" (unknown) - type: string - realtimeAccountUpdaterStatus: - description: |- - The response code from the Real Time Account Updater service. - - Possible return values are: - * CardChanged - * CardExpiryChanged - * CloseAccount - * ContactCardAccountHolder - type: string - receiptFreeText: - description: Message to be displayed on the terminal. - type: string - recurring.firstPspReference: - description: |- - The `pspReference`, of the first recurring payment that created the recurring detail. - - This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. - type: string - recurring.recurringDetailReference: - description: The reference that uniquely identifies the recurring transaction. + BacsDirectDebitDetails: + properties: + bankAccountNumber: + description: The bank account number (without separators). type: string - referred: - description: |- - If the payment is referred, this field is set to true. - - This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. - - Example: true + bankLocationId: + description: The bank routing number of the account. type: string - refusalReasonRaw: - description: |- - Raw refusal reason received from the acquirer, where available. - - Example: AUTHORISED + holderName: + description: The name of the bank account holder. type: string - shopperInteraction: - description: |- - The shopper interaction type of the payment request. - - Example: Ecommerce + type: + default: directdebit_GB + description: '**directdebit_GB**' type: string - shopperReference: - description: |- - The shopperReference passed in the payment request. - - Example: AdyenTestShopperXX + required: + - bankAccountNumber + - bankLocationId + - holderName + - type + BankAccount: + example: + ownerName: ownerName + countryCode: countryCode + taxId: taxId + iban: iban + bankAccountNumber: bankAccountNumber + bankName: bankName + bankLocationId: bankLocationId + bic: bic + bankCity: bankCity + properties: + bankAccountNumber: + description: The bank account number (without separators). type: string - terminalId: - description: |- - The terminal ID used in a point-of-sale payment. - - Example: 06022622 + bankCity: + description: The bank city. type: string - threeDAuthenticated: - description: |- - A Boolean value indicating whether 3DS authentication was completed on this payment. - - Example: true + bankLocationId: + description: The location id of the bank. The field value is `nil` in most + cases. type: string - threeDAuthenticatedResponse: - description: |- - The raw 3DS authentication result from the card issuer. - - Example: N + bankName: + description: The name of the bank. type: string - threeDOffered: - description: |- - A Boolean value indicating whether 3DS was offered for this payment. - - Example: true + bic: + description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) + (BIC) is the SWIFT address assigned to a bank. The field value is `nil` + in most cases. type: string - threeDOfferedResponse: + countryCode: description: |- - The raw enrollment result from the 3DS directory services of the card schemes. + Country code where the bank is located. - Example: Y + A valid value is an ISO two-character country code (e.g. 'NL'). type: string - threeDSVersion: - description: The 3D Secure 2 version. + iban: + description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) + (IBAN). type: string - visaTransactionId: + ownerName: description: |- - The `visaTransactionId`, has a fixed length of 15 numeric characters. - > Contact Support Team to enable this field. + The name of the bank account holder. + If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: + * χ12 is converted to ch12. + * üA is converted to euA. + * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. + After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: + * John17 - allowed. + * J17 - allowed. + * 171 - not allowed. + * John-7 - allowed. + > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. type: string - xid: - description: |- - The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA= + taxId: + description: The bank account holder's tax ID. type: string - ResponseAdditionalDataBillingAddress: + BillDeskOnlineDetails: properties: - billingAddress.city: - description: The billing address city passed in the payment request. + issuer: + description: The issuer id of the shopper's selected bank. type: string - billingAddress.country: - description: |- - The billing address country passed in the payment request. - - Example: NL + type: + default: billdesk_online + description: '**billdesk_online**' type: string - billingAddress.houseNumberOrName: - description: The billing address house number or name passed in the payment - request. + required: + - issuer + - type + BillDeskWalletDetails: + properties: + issuer: + description: The issuer id of the shopper's selected bank. type: string - billingAddress.postalCode: - description: |- - The billing address postal code passed in the payment request. - - Example: 1011 DJ + type: + default: billdesk_wallet + description: '**billdesk_wallet**' type: string - billingAddress.stateOrProvince: - description: |- - The billing address state or province passed in the payment request. - - Example: NH + required: + - issuer + - type + BlikDetails: + properties: + blikCode: + description: BLIK code consisting of 6 digits. type: string - billingAddress.street: - description: The billing address street passed in the payment request. + type: + description: '**blik**' type: string - ResponseAdditionalDataCard: + required: + - type + BrowserInfo: + example: + acceptHeader: acceptHeader + screenWidth: 7 + javaEnabled: true + screenHeight: 2 + timeZoneOffset: 9 + javaScriptEnabled: true + language: language + userAgent: userAgent + colorDepth: 5 properties: - cardBin: - description: |- - The Bank Identification Number of a credit card, which is the first six digits of a card number. - - Example: 521234 + acceptHeader: + description: The accept header value of the shopper's browser. + maxLength: 50 + minLength: 10 type: string - cardHolderName: - description: The cardholder name passed in the payment request. + colorDepth: + description: 'The color depth of the shopper''s browser in bits per pixel. + This should be obtained by using the browser''s `screen.colorDepth` property. + Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' + format: int32 + type: integer + javaEnabled: + description: Boolean value indicating if the shopper's browser is able to + execute Java. + type: boolean + javaScriptEnabled: + default: true + description: Boolean value indicating if the shopper's browser is able to + execute JavaScript. A default 'true' value is assumed if the field is + not present. + type: boolean + language: + description: The `navigator.language` value of the shopper's browser (as + defined in IETF BCP 47). type: string - cardIssuingBank: - description: The bank or the financial institution granting lines of credit - through card association branded payment cards. This information can be - included when available. + screenHeight: + description: The total height of the shopper's device screen in pixels. + format: int32 + type: integer + screenWidth: + description: The total width of the shopper's device screen in pixels. + format: int32 + type: integer + timeZoneOffset: + description: Time difference between UTC time and the shopper's browser + local time, in minutes. + format: int32 + type: integer + userAgent: + description: The user agent value of the shopper's browser. + maxLength: 50 + minLength: 10 type: string - cardIssuingCountry: + required: + - acceptHeader + - colorDepth + - javaEnabled + - language + - screenHeight + - screenWidth + - timeZoneOffset + - userAgent + Card: + example: + cvc: cvc + number: number + holderName: holderName + startMonth: startMonth + issueNumber: issueNumber + expiryMonth: expiryMonth + startYear: startYear + expiryYear: expiryYear + properties: + cvc: description: |- - The country where the card was issued. - - Example: US - type: string - cardIssuingCurrency: - description: "The currency in which the card is issued, if this information\ - \ is available. Provided as the currency code or currency number from\ - \ the ISO-4217 standard. \n\nExample: USD" + The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: + * CVV2/CVC2 – length: 3 digits + * CID – length: 4 digits + > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. + > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). + > When this value is returned in a response, it is always empty because it is not stored. + maxLength: 20 + minLength: 1 type: string - cardPaymentMethod: + expiryMonth: description: |- - The card payment method used for the transaction. - - Example: amex + The card expiry month. + Format: 2 digits, zero-padded for single digits. For example: + * 03 = March + * 11 = November + maxLength: 2 + minLength: 1 type: string - cardSummary: + expiryYear: description: |- - The last four digits of a card number. - > Returned only in case of a card payment. - type: string - ResponseAdditionalDataDeliveryAddress: - properties: - deliveryAddress.city: - description: The delivery address city passed in the payment request. + The card expiry year. + Format: 4 digits. For example: 2020 + maxLength: 4 + minLength: 4 type: string - deliveryAddress.country: - description: |- - The delivery address country passed in the payment request. - - Example: NL + holderName: + description: The name of the cardholder, as printed on the card. + maxLength: 50 + minLength: 1 type: string - deliveryAddress.houseNumberOrName: - description: The delivery address house number or name passed in the payment - request. + issueNumber: + description: The issue number of the card (for some UK debit cards only). + maxLength: 2 + minLength: 1 type: string - deliveryAddress.postalCode: + number: description: |- - The delivery address postal code passed in the payment request. - - Example: 1011 DJ + The card number (4-19 characters). Do not use any separators. + When this value is returned in a response, only the last 4 digits of the card number are returned. + maxLength: 19 + minLength: 4 type: string - deliveryAddress.stateOrProvince: - description: |- - The delivery address state or province passed in the payment request. - - Example: NH + startMonth: + description: The month component of the start date (for some UK debit cards + only). + maxLength: 2 + minLength: 1 type: string - deliveryAddress.street: - description: The delivery address street passed in the payment request. + startYear: + description: The year component of the start date (for some UK debit cards + only). + maxLength: 4 + minLength: 4 type: string - ResponseAdditionalDataInstallments: + required: + - expiryMonth + - expiryYear + - holderName + - number + CardDetails: properties: - installments.value: - description: |- - The number of installments that the payment amount should be charged with. - - Example: 5 - > Only relevant for card payments in countries that support installments. - type: string - installmentPaymentData.installmentType: - description: Type of installment. The value of `installmentType` should - be **IssuerFinanced**. + brand: + description: 'Brand of the card. For example: **plastix**, **hmclub**.' type: string - installmentPaymentData.paymentOptions: - description: |- - Possible values: - * PayInInstallmentsOnly - * PayInFullOnly - * PayInFullOrInstallments + cupsecureplus.smscode: + deprecated: true type: string - installmentPaymentData.option[itemNr].numberOfInstallments: - description: Total number of installments possible for this payment. + cvc: type: string - installmentPaymentData.option[itemNr].interestRate: - description: Interest rate for the installment period. + encryptedCardNumber: type: string - installmentPaymentData.option[itemNr].installmentFee: - description: Installment fee amount in minor units. + encryptedExpiryMonth: type: string - installmentPaymentData.option[itemNr].annualPercentageRate: - description: Annual interest rate. + encryptedExpiryYear: type: string - installmentPaymentData.option[itemNr].firstInstallmentAmount: - description: First Installment Amount in minor units. + expiryMonth: type: string - installmentPaymentData.option[itemNr].subsequentInstallmentAmount: - description: Subsequent Installment Amount in minor units. + expiryYear: type: string - installmentPaymentData.option[itemNr].minimumNumberOfInstallments: - description: Minimum number of installments possible for this payment. + fundingSource: + enum: + - debit type: string - installmentPaymentData.option[itemNr].maximumNumberOfInstallments: - description: Maximum number of installments possible for this payment. + holderName: type: string - installmentPaymentData.option[itemNr].totalAmountDue: - description: Total amount in minor units. + number: type: string - ResponseAdditionalDataNetworkTokens: - properties: - networkToken.available: - description: Indicates whether a network token is available for the specified - card. + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. type: string - networkToken.bin: - description: The Bank Identification Number of a tokenized card, which is - the first six digits of a card number. + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. type: string - networkToken.tokenSummary: - description: The last four digits of a card number. + type: + default: scheme + description: '**scheme**' type: string - ResponseAdditionalDataPayPal: + required: + - encryptedCardNumber + - encryptedExpiryMonth + - encryptedExpiryYear + - type + CellulantDetails: properties: - paypalPayerStatus: - description: |- - The status of the buyer's PayPal account. - - Example: unverified + issuerId: + description: The issuer's ID type: string - paypalPayerResidenceCountry: - description: |- - The buyer's country of residence. - - Example: NL + type: + default: cellulant + description: '**Cellulant**' type: string - paypalPayerId: - description: |- - The buyer's PayPal ID. - - Example: LF5HCWWBRV2KL + required: + - type + CheckoutAwaitAction: + properties: + paymentData: + description: When non-empty, contains a value that you must submit to the + `/payments/details` endpoint. In some cases, required for polling. type: string - paypalEmail: - description: |- - The buyer's PayPal account email address. - - Example: paypaltest@adyen.com + paymentMethodType: + description: Specifies the payment method. type: string - paypalProtectionEligibility: - description: |- - The eligibility for PayPal Seller Protection for this payment. - - Example: Ineligible + url: + description: Specifies the URL to redirect to. type: string - ResponseAdditionalDataSepa: - properties: - sepadirectdebit.dateOfSignature: - description: |- - The transaction signature date. - - Format: yyyy-MM-dd - type: string - sepadirectdebit.mandateId: - description: Its value corresponds to the pspReference value of the transaction. - type: string - sepadirectdebit.sequenceType: - description: |- - This field can take one of the following values: - * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. - * First: (FRST) Initial/first collection in a series of direct debit instructions. - * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. - * Final: (FNAL) Last/final collection in a series of direct debit instructions. - - Example: OOFF - type: string - Address: + CheckoutBalanceCheckRequest: example: - country: country - stateOrProvince: stateOrProvince - city: city - houseNumberOrName: houseNumberOrName - street: street - postalCode: postalCode + dccQuote: + reference: reference + validTill: 2000-01-23T04:56:07.000+00:00 + signature: signature + accountType: accountType + buy: + currency: currency + value: 5 + sell: + currency: currency + value: 5 + interbank: + currency: currency + value: 5 + source: source + type: type + basePoints: 2 + account: account + baseAmount: + currency: currency + value: 5 + metadata: + key: metadata + splits: + - reference: reference + amount: + currency: currency + value: 7 + description: description + type: BalanceAccount + account: account + - reference: reference + amount: + currency: currency + value: 7 + description: description + type: BalanceAccount + account: account + telephoneNumber: telephoneNumber + deviceFingerprint: deviceFingerprint + socialSecurityNumber: socialSecurityNumber + shopperIP: shopperIP + mcc: mcc + threeDSAuthenticationOnly: false + merchantRiskIndicator: + deliveryTimeframe: electronicDelivery + reorderItems: true + preOrderPurchase: true + preOrderDate: 2000-01-23T04:56:07.000+00:00 + giftCardAmount: + currency: currency + value: 5 + deliveryEmail: deliveryEmail + giftCardCount: 1 + addressMatch: true + deliveryAddressIndicator: shipToBillingAddress + reference: reference + shopperName: + firstName: firstName + lastName: lastName + gender: MALE + infix: infix + deliveryAddress: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode + installments: + plan: regular + value: 7 + recurringProcessingModel: CardOnFile + selectedRecurringDetailReference: selectedRecurringDetailReference + shopperInteraction: Ecommerce + totalsGroup: totalsGroup + additionalData: "" + selectedBrand: selectedBrand + deliveryDate: 2000-01-23T04:56:07.000+00:00 + trustedShopper: true + accountInfo: + passwordChangeDate: 2000-01-23T04:56:07.000+00:00 + paymentAccountIndicator: notApplicable + suspiciousActivity: true + deliveryAddressUsageIndicator: thisTransaction + pastTransactionsYear: 1 + accountType: notApplicable + homePhone: homePhone + paymentAccountAge: 2000-01-23T04:56:07.000+00:00 + accountAgeIndicator: notApplicable + deliveryAddressUsageDate: 2000-01-23T04:56:07.000+00:00 + accountChangeDate: 2000-01-23T04:56:07.000+00:00 + accountCreationDate: 2000-01-23T04:56:07.000+00:00 + mobilePhone: mobilePhone + pastTransactionsDay: 6 + accountChangeIndicator: thisTransaction + passwordChangeIndicator: notApplicable + addCardAttemptsDay: 0 + workPhone: workPhone + purchasesLast6Months: 5 + fraudOffset: 4 + merchantOrderReference: merchantOrderReference + amount: + currency: currency + value: 5 + additionalAmount: + currency: currency + value: 5 + recurring: + recurringExpiry: 2000-01-23T04:56:07.000+00:00 + recurringFrequency: recurringFrequency + tokenService: VISATOKENSERVICE + contract: ONECLICK + recurringDetailName: recurringDetailName + dateOfBirth: 2000-01-23T04:56:07.000+00:00 + shopperEmail: shopperEmail + sessionId: sessionId + store: store + merchantAccount: merchantAccount + threeDS2RequestData: + notificationURL: notificationURL + whiteListStatus: whiteListStatus + authenticationOnly: false + sdkMaxTimeout: 1 + sdkEncData: sdkEncData + acquirerBIN: acquirerBIN + mcc: mcc + threeDSRequestorID: threeDSRequestorID + deviceChannel: deviceChannel + deviceRenderOptions: + sdkUiType: + - multiSelect + - multiSelect + sdkInterface: both + sdkEphemPubKey: + kty: kty + crv: crv + x: x + y: "y" + merchantName: merchantName + transactionType: goodsOrServicePurchase + threeDSRequestorURL: threeDSRequestorURL + sdkReferenceNumber: sdkReferenceNumber + challengeIndicator: noPreference + threeDSRequestorName: threeDSRequestorName + acquirerMerchantID: acquirerMerchantID + sdkAppID: sdkAppID + messageVersion: 2.1.0 + threeDSCompInd: threeDSCompInd + sdkTransID: sdkTransID + orderReference: orderReference + paymentMethod: + key: paymentMethod + billingAddress: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode + shopperLocale: shopperLocale + captureDelayHours: 3 + applicationInfo: + adyenLibrary: + name: name + version: version + merchantApplication: + name: name + version: version + adyenPaymentSource: + name: name + version: version + merchantDevice: + reference: reference + os: os + osVersion: osVersion + shopperInteractionDevice: + os: os + osVersion: osVersion + locale: locale + externalPlatform: + name: name + integrator: integrator + version: version + browserInfo: + acceptHeader: acceptHeader + screenWidth: 7 + javaEnabled: true + screenHeight: 2 + timeZoneOffset: 9 + javaScriptEnabled: true + language: language + userAgent: userAgent + colorDepth: 5 + shopperReference: shopperReference + shopperStatement: shopperStatement properties: - city: - description: The name of the city. - type: string - country: + accountInfo: + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + $ref: '#/components/schemas/Amount' + additionalData: + anyOf: + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' description: |- - The two-character country code as defined in ISO-3166-1 alpha-2. For example, **US**. - > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. - type: string - houseNumberOrName: - description: The number or name of the house. - type: string - postalCode: - description: A maximum of five digits for an address in the US, or a maximum - of ten characters for an address in all other countries. - type: string - stateOrProvince: + This field contains additional data, which may be required for a particular payment request. + + The `additionalData` object consists of entries, each of which includes the key and value. + amount: + $ref: '#/components/schemas/Amount' + applicationInfo: + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + $ref: '#/components/schemas/Address' + browserInfo: + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + dateOfBirth: description: |- - State or province codes as defined in ISO 3166-2. For example, **CA** in the US or **ON** in Canada. - > Required for the US and Canada. + The shopper's date of birth. + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + format: date-time type: string - street: + dccQuote: + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + $ref: '#/components/schemas/Address' + deliveryDate: description: |- - The name of the street. - > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. + The date and time the purchased goods should be delivered. + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + Example: 2017-07-17T13:42:40.428+01:00 + format: date-time type: string - required: - - city - - country - - houseNumberOrName - - postalCode - - street - Amount: - example: - currency: currency - value: 0 - properties: - currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - maxLength: 3 - minLength: 3 + deviceFingerprint: + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). type: string - value: - description: |- - The payable amount that can be charged for the transaction. - - The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). - format: int64 + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 type: integer - required: - - currency - - value - ApplicationInfo: - example: - adyenLibrary: - name: name - version: version - merchantApplication: - name: name - version: version - adyenPaymentSource: - name: name - version: version - merchantDevice: - reference: reference - os: os - osVersion: osVersion - shopperInteractionDevice: - os: os - osVersion: osVersion - locale: locale - externalPlatform: - name: name - integrator: integrator - version: version - properties: - adyenLibrary: - $ref: '#/components/schemas/CommonField' - adyenPaymentSource: - $ref: '#/components/schemas/CommonField' - externalPlatform: - $ref: '#/components/schemas/ExternalPlatform' - merchantApplication: - $ref: '#/components/schemas/CommonField' - merchantDevice: - $ref: '#/components/schemas/MerchantDevice' - shopperInteractionDevice: - $ref: '#/components/schemas/ShopperInteractionDevice' - Avs: - example: - addressEditable: true - enabled: "yes" - properties: - addressEditable: - description: Indicates whether the shopper is allowed to modify the billing - address for the current payment request. - type: boolean - enabled: + installments: + $ref: '#/components/schemas/Installments' + mcc: + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: description: |- - Specifies whether the shopper should enter their billing address during checkout. - + This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. + The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. + > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + type: string + merchantRiskIndicator: + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + additionalProperties: + type: string + description: |- + Metadata consists of entries, each of which includes a key and a value. + Limitations: Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". + type: object + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + paymentMethod: + additionalProperties: + type: string + description: The collection that contains the type of the payment method + and its specific information. + type: object + recurring: + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + description: | + Defines a recurring payment type. Allowed values: - * yes — Perform AVS checks for every card payment. - * automatic — Perform AVS checks only when required to optimize the conversion rate. - * no — Do not perform AVS checks. + * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. + * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. + * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. enum: - - "yes" - - "no" - - automatic + - CardOnFile + - Subscription + - UnscheduledCardOnFile type: string - BankAccount: - example: - ownerName: ownerName - countryCode: countryCode - taxId: taxId - iban: iban - bankAccountNumber: bankAccountNumber - bankName: bankName - bankLocationId: bankLocationId - bic: bic - bankCity: bankCity - properties: - bankAccountNumber: - description: The bank account number (without separators). + reference: + description: |- + The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. + If you need to provide multiple references for a transaction, separate them with hyphens ("-"). + Maximum length: 80 characters. type: string - bankCity: - description: The bank city. + selectedBrand: + description: |- + Some payment methods require defining a value for this field to specify how to process the transaction. + + For the Bancontact payment method, it can be set to: + * `maestro` (default), to be processed like a Maestro card, or + * `bcmc`, to be processed like a Bancontact card. type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. type: string - bankName: - description: The name of the bank. + sessionId: + description: A session ID used to identify a payment session. type: string - bic: - description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) - (BIC) is the SWIFT address assigned to a bank. The field value is `nil` - in most cases. + shopperEmail: + description: |- + The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. + > For 3D Secure 2 transactions, schemes require the `shopperEmail` for both `deviceChannel` **browser** and **app**. type: string - countryCode: + shopperIP: description: |- - Country code where the bank is located. + The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). + > Required for 3D Secure 2 transactions. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new). + type: string + shopperInteraction: + description: |- + Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. + For the web service API, Adyen assumes Ecommerce shopper interaction by default. - A valid value is an ISO two-character country code (e.g. 'NL'). + This field has the following possible values: + * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. + * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). + * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. + * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + enum: + - Ecommerce + - ContAuth + - Moto + - POS type: string - iban: - description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) - (IBAN). + shopperLocale: + description: The combination of a language code and a country code to specify + the language to be used in the payment. type: string - ownerName: + shopperName: + $ref: '#/components/schemas/Name' + shopperReference: description: |- - The name of the bank account holder. - If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: - * χ12 is converted to ch12. - * üA is converted to euA. - * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. - After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: - * John17 - allowed. - * J17 - allowed. - * 171 - not allowed. - * John-7 - allowed. - > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. + Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. + > This field is required for recurring payments. type: string - taxId: - description: The bank account holder's tax ID. + shopperStatement: + description: |- + The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. type: string - BrowserInfo: - example: - acceptHeader: acceptHeader - screenWidth: 7 - javaEnabled: true - screenHeight: 2 - timeZoneOffset: 9 - javaScriptEnabled: true - language: language - userAgent: userAgent - colorDepth: 5 - properties: - acceptHeader: - description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 + socialSecurityNumber: + description: The shopper's social security number. type: string - colorDepth: - description: 'The color depth of the shopper''s browser in bits per pixel. - This should be obtained by using the browser''s `screen.colorDepth` property. - Accepted values: 1, 4, 8, 15, 16, 24, 32 or 48 bit color depth.' - format: int32 - type: integer - javaEnabled: - description: Boolean value indicating if the shopper's browser is able to - execute Java. - type: boolean - javaScriptEnabled: - description: Boolean value indicating if the shopper's browser is able to - execute JavaScript. A default 'true' value is assumed if the field is - not present. - type: boolean - language: - description: The `navigator.language` value of the shopper's browser (as - defined in IETF BCP 47). + splits: + description: Information on how the payment should be split between accounts + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + store: + description: The physical store, for which this payment is processed. + maxLength: 16 + minLength: 1 type: string - screenHeight: - description: The total height of the shopper's device screen in pixels. - format: int32 - type: integer - screenWidth: - description: The total width of the shopper's device screen in pixels. - format: int32 - type: integer - timeZoneOffset: - description: Time difference between UTC time and the shopper's browser - local time, in minutes. - format: int32 - type: integer - userAgent: - description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 + telephoneNumber: + description: The shopper's telephone number. + type: string + threeDS2RequestData: + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 type: string + trustedShopper: + description: Set to true if the payment should be routed to a trusted MID. + type: boolean required: - - acceptHeader - - colorDepth - - javaEnabled - - language - - screenHeight - - screenWidth - - timeZoneOffset - - userAgent - Card: + - amount + - merchantAccount + - paymentMethod + - reference + CheckoutBalanceCheckResponse: example: - cvc: cvc - number: number - holderName: holderName - startMonth: startMonth - issueNumber: issueNumber - expiryMonth: expiryMonth - startYear: startYear - expiryYear: expiryYear + balance: + currency: currency + value: 5 + resultCode: AuthenticationFinished + refusalReason: refusalReason + additionalData: "" + transactionLimit: + currency: currency + value: 5 + fraudResult: + accountScore: 0 + results: + - accountScore: 6 + name: name + checkId: 1 + - accountScore: 6 + name: name + checkId: 1 + pspReference: pspReference properties: - cvc: + additionalData: + anyOf: + - $ref: '#/components/schemas/ResponseAdditionalDataCommon' + - $ref: '#/components/schemas/ResponseAdditionalData3DSecure' + - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress' + - $ref: '#/components/schemas/ResponseAdditionalDataCard' + - $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress' + - $ref: '#/components/schemas/ResponseAdditionalDataInstallments' + - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens' + - $ref: '#/components/schemas/ResponseAdditionalDataOpi' + - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' + - $ref: '#/components/schemas/ResponseAdditionalDataSepa' + description: This field contains additional data, which may be required + to return in a particular payment response. To choose data fields to be + returned, go to **Customer Area** > **Account** > **API URLs** > **Additional + data settings**. + balance: + $ref: '#/components/schemas/Amount' + fraudResult: + $ref: '#/components/schemas/FraudResult' + pspReference: description: |- - The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: - * CVV2/CVC2 – length: 3 digits - * CID – length: 4 digits - > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. - > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). - > When this value is returned in a response, it is always empty because it is not stored. - maxLength: 20 - minLength: 1 + Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + + > `pspReference` is returned only for non-redirect payment methods. type: string - expiryMonth: + refusalReason: description: |- - The card expiry month. - Format: 2 digits, zero-padded for single digits. For example: - * 03 = March - * 11 = November - maxLength: 2 - minLength: 1 + If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + + For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string - expiryYear: + resultCode: description: |- - The card expiry year. - Format: 4 digits. For example: 2020 - maxLength: 4 - minLength: 4 - type: string - holderName: - description: The name of the cardholder, as printed on the card. - maxLength: 50 - minLength: 1 - type: string - issueNumber: - description: The issue number of the card (for some UK debit cards only). - maxLength: 2 - minLength: 1 + The result of the payment. For more information, see [Result codes](https://docs.adyen.com/checkout/payment-result-codes). + + Possible values: + + * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. + * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). + * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. + * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. + * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. + * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. + * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. + * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. + * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. + * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. + * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. + * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused type: string - number: - description: |- - The card number (4-19 characters). Do not use any separators. - When this value is returned in a response, only the last 4 digits of the card number are returned. - maxLength: 19 - minLength: 4 + transactionLimit: + $ref: '#/components/schemas/Amount' + required: + - balance + CheckoutCancelOrderRequest: + example: + merchantAccount: merchantAccount + order: + orderData: orderData + pspReference: pspReference + properties: + merchantAccount: + description: The merchant account identifier that orderData belongs to. type: string - startMonth: - description: The month component of the start date (for some UK debit cards - only). - maxLength: 2 - minLength: 1 + order: + $ref: '#/components/schemas/CheckoutOrder' + required: + - merchantAccount + - order + CheckoutCancelOrderResponse: + example: + resultCode: resultCode + pspReference: pspReference + properties: + pspReference: + description: A unique reference of the cancellation request. type: string - startYear: - description: The year component of the start date (for some UK debit cards - only). - maxLength: 4 - minLength: 4 + resultCode: + description: The result of the cancellation request. type: string required: - - expiryMonth - - expiryYear - - holderName - - number - CheckoutPaymentsAction: + - pspReference + - resultCode + CheckoutCreateOrderRequest: example: - surcharge: - currency: currency - value: 0 - instructionsUrl: instructionsUrl - qrCodeData: qrCodeData - data: '{}' - method: method - downloadUrl: downloadUrl - shopperEmail: shopperEmail - type: await - expiresAt: expiresAt - issuer: issuer - url: url - merchantName: merchantName - token: token reference: reference - totalAmount: - currency: currency - value: 0 - shopperName: shopperName - maskedTelephoneNumber: maskedTelephoneNumber - initialAmount: + amount: currency: currency - value: 0 - paymentData: paymentData - alternativeReference: alternativeReference - merchantReference: merchantReference - paymentMethodType: paymentMethodType - entity: entity + value: 5 + merchantAccount: merchantAccount + expiresAt: expiresAt properties: - alternativeReference: - description: The voucher alternative reference code. + amount: + $ref: '#/components/schemas/Amount' + expiresAt: + description: The date that order expires; e.g. 2019-03-23T12:25:28Z. If + not provided, the default expiry duration is 1 day. type: string - data: - description: When the redirect URL must be accessed via POST, use this data - to post to the redirect URL. - type: object - downloadUrl: - description: The URL to download the voucher. + merchantAccount: + description: The merchant account identifier, with which you want to process + the order. type: string - entity: - description: An entity number of Multibanco. + reference: + description: A custom reference identifying the order. type: string + required: + - amount + - merchantAccount + CheckoutCreateOrderResponse: + example: + remainingAmount: + currency: currency + value: 5 + resultCode: AuthenticationFinished + orderData: orderData + refusalReason: refusalReason + additionalData: "" + fraudResult: + accountScore: 0 + results: + - accountScore: 6 + name: name + checkId: 1 + - accountScore: 6 + name: name + checkId: 1 + pspReference: pspReference + expiresAt: expiresAt + properties: + additionalData: + anyOf: + - $ref: '#/components/schemas/ResponseAdditionalDataCommon' + - $ref: '#/components/schemas/ResponseAdditionalData3DSecure' + - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress' + - $ref: '#/components/schemas/ResponseAdditionalDataCard' + - $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress' + - $ref: '#/components/schemas/ResponseAdditionalDataInstallments' + - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens' + - $ref: '#/components/schemas/ResponseAdditionalDataOpi' + - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' + - $ref: '#/components/schemas/ResponseAdditionalDataSepa' + description: This field contains additional data, which may be required + to return in a particular payment response. To choose data fields to be + returned, go to **Customer Area** > **Account** > **API URLs** > **Additional + data settings**. expiresAt: - description: The date time of the voucher expiry. + description: The date that the order will expire. type: string - initialAmount: - $ref: '#/components/schemas/Amount' - instructionsUrl: - description: The URL to the detailed instructions to make payment using - the voucher. + fraudResult: + $ref: '#/components/schemas/FraudResult' + orderData: + description: The encrypted data that will be used by merchant for adding + payments to the order. type: string - issuer: - description: The issuer of the voucher. + pspReference: + description: |- + Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + + > `pspReference` is returned only for non-redirect payment methods. type: string - maskedTelephoneNumber: - description: The shopper telephone number (partially masked). + refusalReason: + description: |- + If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + + For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string - merchantName: - description: The merchant name. + remainingAmount: + $ref: '#/components/schemas/Amount' + resultCode: + description: |- + The result of the payment. For more information, see [Result codes](https://docs.adyen.com/checkout/payment-result-codes). + + Possible values: + + * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. + * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). + * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. + * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. + * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. + * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. + * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. + * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. + * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. + * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. + * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. + * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused type: string - merchantReference: - description: The merchant reference. + required: + - expiresAt + - orderData + - remainingAmount + CheckoutDonationAction: + properties: + paymentData: + description: When non-empty, contains a value that you must submit to the + `/payments/details` endpoint. In some cases, required for polling. type: string - method: - description: Specifies the HTTP method, for example GET or POST. + paymentMethodType: + description: Specifies the payment method. + type: string + url: + description: Specifies the URL to redirect to. + type: string + CheckoutOneTimePasscodeAction: + properties: + paymentData: + description: When non-empty, contains a value that you must submit to the + `/payments/details` endpoint. In some cases, required for polling. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + redirect: + $ref: '#/components/schemas/Redirect' + resendInterval: + description: The interval in second between OTP resend. + format: int32 + type: integer + resendMaxAttempts: + description: The maximum number of OTP resend attempts. + format: int32 + type: integer + resendUrl: + description: The URL, to which you make POST request to trigger OTP resend. + type: string + url: + description: Specifies the URL to redirect to. + type: string + CheckoutOrder: + example: + orderData: orderData + pspReference: pspReference + properties: + orderData: + description: The encrypted order data. + type: string + pspReference: + description: The `pspReference` that belongs to the order. + type: string + required: + - orderData + - pspReference + CheckoutOrderResponse: + example: + reference: reference + remainingAmount: + currency: currency + value: 5 + orderData: orderData + pspReference: pspReference + expiresAt: expiresAt + properties: + expiresAt: + description: The expiry date for the order. + type: string + orderData: + description: The encrypted order data. + type: string + pspReference: + description: The `pspReference` that belongs to the order. type: string + reference: + description: The merchant reference for the order. + type: string + remainingAmount: + $ref: '#/components/schemas/Amount' + required: + - pspReference + CheckoutQrCodeAction: + properties: paymentData: description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. @@ -2204,6 +2925,162 @@ components: qrCodeData: description: The contents of the QR code as a UTF8 string. type: string + url: + description: Specifies the URL to redirect to. + type: string + CheckoutRedirectAction: + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + paymentData: + description: When non-empty, contains a value that you must submit to the + `/payments/details` endpoint. In some cases, required for polling. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + url: + description: Specifies the URL to redirect to. + type: string + CheckoutSDKAction: + properties: + paymentData: + description: When non-empty, contains a value that you must submit to the + `/payments/details` endpoint. In some cases, required for polling. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + sdkData: + additionalProperties: + type: string + description: The data to pass to the SDK. + type: object + url: + description: Specifies the URL to redirect to. + type: string + CheckoutThreeDS2Action: + properties: + paymentData: + description: When non-empty, contains a value that you must submit to the + `/payments/details` endpoint. In some cases, required for polling. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + subtype: + description: A sub type of the token + type: string + token: + description: A token to pass to the 3DS2 Component to get the fingerprint. + type: string + url: + description: Specifies the URL to redirect to. + type: string + CheckoutThreeDS2ChallengeAction: + properties: + paymentData: + description: When non-empty, contains a value that you must submit to the + `/payments/details` endpoint. In some cases, required for polling. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + token: + description: A token to pass to the 3DS2 Component to get the challenge. + type: string + url: + description: Specifies the URL to redirect to. + type: string + CheckoutThreeDS2FingerPrintAction: + properties: + paymentData: + description: When non-empty, contains a value that you must submit to the + `/payments/details` endpoint. In some cases, required for polling. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + token: + description: A token to pass to the 3DS2 Component to get the fingerprint. + type: string + url: + description: Specifies the URL to redirect to. + type: string + CheckoutUtilityRequest: + example: + originDomains: + - originDomains + - originDomains + properties: + originDomains: + description: The list of origin domains, for which origin keys are requested. + items: + type: string + type: array + required: + - originDomains + CheckoutUtilityResponse: + example: + originKeys: + key: originKeys + properties: + originKeys: + additionalProperties: + type: string + description: The list of origin keys for all requested domains. For each + list item, the key is the domain and the value is the origin key. + type: object + CheckoutVoucherAction: + properties: + alternativeReference: + description: The voucher alternative reference code. + type: string + collectionInstitutionNumber: + description: A collection institution number (store number) for Econtext + Pay-Easy ATM. + type: string + downloadUrl: + description: The URL to download the voucher. + type: string + entity: + description: An entity number of Multibanco. + type: string + expiresAt: + description: The date time of the voucher expiry. + type: string + initialAmount: + $ref: '#/components/schemas/Amount' + instructionsUrl: + description: The URL to the detailed instructions to make payment using + the voucher. + type: string + issuer: + description: The issuer of the voucher. + type: string + maskedTelephoneNumber: + description: The shopper telephone number (partially masked). + type: string + merchantName: + description: The merchant name. + type: string + merchantReference: + description: The merchant reference. + type: string + paymentData: + description: When non-empty, contains a value that you must submit to the + `/payments/details` endpoint. In some cases, required for polling. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string reference: description: The voucher reference code. type: string @@ -2215,25 +3092,8 @@ components: type: string surcharge: $ref: '#/components/schemas/Amount' - token: - description: A token to pass to the 3DS2 Component to get the fingerprint/challenge. - type: string totalAmount: $ref: '#/components/schemas/Amount' - type: - description: Enum that specifies the action that needs to be taken by the - client. - enum: - - await - - donate - - qrCode - - redirect - - sdk - - threeDS2Challenge - - threeDS2Fingerprint - - voucher - - wechatpaySDK - type: string url: description: Specifies the URL to redirect to. type: string @@ -2279,7 +3139,8 @@ components: example: cardHolderName: NONE installments: - value: 6 + plan: regular + value: 7 shopperInput: deliveryAddress: editable personalDetails: editable @@ -2309,28 +3170,84 @@ components: $ref: '#/components/schemas/ShopperInput' CreatePaymentLinkRequest: example: - amount: - currency: currency - value: 0 + metadata: + key: metadata + splits: + - reference: reference + amount: + currency: currency + value: 7 + description: description + type: BalanceAccount + account: account + - reference: reference + amount: + currency: currency + value: 7 + description: description + type: BalanceAccount + account: account description: description - shopperEmail: shopperEmail - store: store - allowedPaymentMethods: - - allowedPaymentMethods - - allowedPaymentMethods - expiresAt: expiresAt - reusable: true + lineItems: + - quantity: 1 + amountExcludingTax: 0 + imageUrl: imageUrl + taxPercentage: 5 + description: description + id: id + amountIncludingTax: 6 + productUrl: productUrl + taxAmount: 5 + taxCategory: High + - quantity: 1 + amountExcludingTax: 0 + imageUrl: imageUrl + taxPercentage: 5 + description: description + id: id + amountIncludingTax: 6 + productUrl: productUrl + taxAmount: 5 + taxCategory: High reference: reference - storePaymentMethod: true - merchantAccount: merchantAccount - deliveryAddress: - country: country - stateOrProvince: stateOrProvince - city: city + shopperName: + firstName: firstName + lastName: lastName + gender: MALE + infix: infix + deliveryAddress: + country: country + stateOrProvince: stateOrProvince + city: city houseNumberOrName: houseNumberOrName street: street postalCode: postalCode countryCode: countryCode + recurringProcessingModel: CardOnFile + blockedPaymentMethods: + - blockedPaymentMethods + - blockedPaymentMethods + returnUrl: returnUrl + merchantOrderReference: merchantOrderReference + amount: + currency: currency + value: 5 + shopperEmail: shopperEmail + store: store + allowedPaymentMethods: + - allowedPaymentMethods + - allowedPaymentMethods + riskData: + fraudOffset: 2 + customFields: + key: customFields + profileReference: profileReference + clientData: clientData + expiresAt: expiresAt + reusable: true + storePaymentMethod: true + merchantAccount: merchantAccount + deliverAt: 2000-01-23T04:56:07.000+00:00 billingAddress: country: country stateOrProvince: stateOrProvince @@ -2338,11 +3255,29 @@ components: houseNumberOrName: houseNumberOrName street: street postalCode: postalCode - blockedPaymentMethods: - - blockedPaymentMethods - - blockedPaymentMethods shopperLocale: shopperLocale - returnUrl: returnUrl + applicationInfo: + adyenLibrary: + name: name + version: version + merchantApplication: + name: name + version: version + adyenPaymentSource: + name: name + version: version + merchantDevice: + reference: reference + os: os + osVersion: osVersion + shopperInteractionDevice: + os: os + osVersion: osVersion + locale: locale + externalPlatform: + name: name + integrator: integrator + version: version shopperReference: shopperReference properties: allowedPaymentMethods: @@ -2355,6 +3290,8 @@ components: type: array amount: $ref: '#/components/schemas/Amount' + applicationInfo: + $ref: '#/components/schemas/ApplicationInfo' billingAddress: $ref: '#/components/schemas/Address' blockedPaymentMethods: @@ -2366,102 +3303,135 @@ components: type: string type: array countryCode: - description: The shopper's country code. + description: The shopper's two-letter country code. + type: string + deliverAt: + description: The date and time the purchased goods should be delivered. + format: date-time type: string deliveryAddress: $ref: '#/components/schemas/Address' description: description: |- - A short description visible on the Pay By Link page. + A short description visible on the payment page. Maximum length: 280 characters. type: string expiresAt: - description: The date that the Pay By Link expires, in ISO 8601 format. - For example, 2019-11-23T12:25:28Z. Maximum expiry date should be 30 days - from when the payment link is created. If not provided, the default expiry - duration is 24 hours. + description: The date that the payment link expires, in ISO 8601 format. + For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum + expiry date should be 30 days from when the payment link is created. If + not provided, the default expiry is set to 24 hours after the payment + link is created. type: string + lineItems: + description: |- + Price and product information about the purchased items, to be included on the invoice sent to the shopper. + This parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip. + items: + $ref: '#/components/schemas/LineItem' + type: array merchantAccount: - description: The merchant account identifier, with which you want to process - the transaction. + description: The merchant account identifier for which the payment link + is created. type: string - reference: + merchantOrderReference: + description: This reference allows linking multiple transactions to each + other for reporting purposes (for example, order auth-rate). The reference + should be unique per billing cycle. + type: string + metadata: + additionalProperties: + type: string description: |- - The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. - If you need to provide multiple references for a transaction, separate them with hyphens ("-"). - Maximum length: 80 characters. + Metadata consists of entries, each of which includes a key and a value. + Limitations: + * Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit" + * Maximum 20 characters per key. When exceeding, the "178" error occurs: "Metadata key size exceeds limit" + * A key cannot have the name `checkout.linkId`. Whatever value is present under that key is going to be replaced by the real link id + type: object + recurringProcessingModel: + description: | + Defines a recurring payment type. + Allowed values: + * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. + * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. + * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + reference: + description: A reference that is used to uniquely identify the payment in + future communications about the payment status. type: string returnUrl: description: |- Website URL used for redirection after payment is completed. - If provided, a **Continue** button will be shown on the page. If shoppers select the button, they are redirected to the specified URL. + If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL. type: string reusable: description: Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only. type: boolean + riskData: + $ref: '#/components/schemas/RiskData' shopperEmail: - description: |- - The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. - > For 3D Secure 2 transactions, schemes require the `shopperEmail` for both `deviceChannel` **browser** and **app**. + description: The shopper's email address. type: string shopperLocale: - description: The combination of a language code and a country code to specify - the language to be used in the payment. + description: |- + The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`. + + For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/checkout/pay-by-link#language-and-localization). type: string + shopperName: + $ref: '#/components/schemas/Name' shopperReference: - description: |- - The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). - > This field is required for recurring payments. + description: A unique identifier for the shopper (for example, user ID or + account ID). type: string + splits: + description: Information on how the payment should be split between accounts + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array store: description: The physical store, for which this payment is processed. type: string storePaymentMethod: - description: When true and `shopperReference` is provided, the payment details - will be stored. + description: When this is set to **true** and the `shopperReference` is + provided, the payment details will be stored. type: boolean required: - amount - - countryCode - merchantAccount - reference - CreatePaymentLinkResponse: - example: - reference: reference - amount: - currency: currency - value: 0 - expiresAt: expiresAt - url: url - properties: - amount: - $ref: '#/components/schemas/Amount' - expiresAt: - description: The date that the Pay By Link expires; e.g. 2019-03-23T12:25:28Z. - type: string - reference: - description: The reference that was specified when the Pay By Link URL was - created. - type: string - url: - description: The URL at which the shopper can complete the payment. - type: string - required: - - expiresAt - - reference - - url DetailsRequest: example: paymentData: paymentData - details: '{}' + details: + cupsecureplus.smscode: cupsecureplus.smscode + orderID: orderID + payerID: payerID + oneTimePasscode: oneTimePasscode + threeds2.challengeResult: threeds2.challengeResult + redirectResult: redirectResult + threeds2.fingerprint: threeds2.fingerprint + payload: payload + billingToken: billingToken + paymentID: paymentID + MD: MD + PaReq: PaReq + PaRes: PaRes + paymentStatus: paymentStatus + facilitatorAccessToken: facilitatorAccessToken threeDSAuthenticationOnly: true properties: details: - description: Use this collection to submit the details that were returned - as a result of the `/payments` call. - type: object + $ref: '#/components/schemas/PaymentCompletionDetails' paymentData: description: The `paymentData` value that you received in the response to the `/payments` call. @@ -2478,18 +3448,19 @@ components: sdkUiType: - multiSelect - multiSelect - sdkInterface: Html + sdkInterface: both properties: sdkInterface: + default: both description: |- Supported SDK interface types. Allowed values: - * Native - * Html + * native + * html * both enum: - - Html - - Native + - native + - html - both type: string sdkUiType: @@ -2510,6 +3481,110 @@ components: - text type: string type: array + DokuDetails: + properties: + firstName: + description: The shopper's first name. + type: string + infix: + type: string + lastName: + description: The shopper's last name. + type: string + ovoId: + type: string + shopperEmail: + description: The shopper's email. + type: string + type: + description: '**doku**' + enum: + - doku_mandiri_va + - doku_cimb_va + - doku_danamon_va + - doku_bni_va + - doku_permata_lite_atm + - doku_bri_va + - doku_bca_va + - doku_alfamart + - doku_indomaret + type: string + required: + - firstName + - lastName + - shopperEmail + - type + DotpayDetails: + properties: + issuer: + description: The Dotpay issuer value of the shopper's selected bank. Set + this to an **id** of a Dotpay issuer to preselect it. + type: string + type: + default: dotpay + description: '**dotpay**' + type: string + required: + - issuer + - type + DragonpayDetails: + properties: + issuer: + description: The Dragonpay issuer value of the shopper's selected bank. + Set this to an **id** of a Dragonpay issuer to preselect it. + type: string + shopperEmail: + description: The shopper’s email address. + type: string + type: + description: '**dragonpay**' + enum: + - dragonpay_ebanking + - dragonpay_otc_banking + - dragonpay_otc_non_banking + - dragonpay_otc_philippines + type: string + required: + - issuer + - type + EcontextVoucherDetails: + properties: + firstName: + description: The shopper's first name. + type: string + lastName: + description: The shopper's last name. + type: string + shopperEmail: + description: The shopper's email. + type: string + telephoneNumber: + description: The shopper's contact number. + type: string + type: + description: '**econtextvoucher**' + enum: + - econtext_seveneleven + - econtext_stores + type: string + required: + - firstName + - lastName + - shopperEmail + - telephoneNumber + - type + EntercashDetails: + properties: + issuer: + description: The issuer id of the shopper's selected bank. + type: string + type: + default: entercash + description: '**entercash**' + type: string + required: + - issuer + - type ExternalPlatform: example: name: name @@ -2533,20 +3608,20 @@ components: accountType: accountType buy: currency: currency - value: 0 + value: 5 sell: currency: currency - value: 0 + value: 5 interbank: currency: currency - value: 0 + value: 5 source: source type: type - basePoints: 1 + basePoints: 2 account: account baseAmount: currency: currency - value: 0 + value: 5 properties: account: description: The account name. @@ -2628,11 +3703,87 @@ components: type: array required: - accountScore + GiropayDetails: + properties: + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: giropay + description: '**giropay**' + type: string + required: + - type + GooglePayDetails: + properties: + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + googlePayCardNetwork: + type: string + googlePayToken: + type: string + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + type: string + required: + - googlePayToken + - type + IdealDetails: + properties: + issuer: + description: The iDEAL issuer value of the shopper's selected bank. Set + this to an **id** of an iDEAL issuer to preselect it. + type: string + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: ideal + description: '**ideal**' + type: string + required: + - issuer + - type InputDetail: example: - configuration: '{}' + configuration: + key: configuration details: - - configuration: '{}' + - configuration: + key: configuration optional: true type: type items: @@ -2642,7 +3793,8 @@ components: id: id value: value key: key - - configuration: '{}' + - configuration: + key: configuration optional: true type: type items: @@ -2654,7 +3806,8 @@ components: key: key optional: true inputDetails: - - configuration: '{}' + - configuration: + key: configuration optional: true type: type items: @@ -2664,7 +3817,8 @@ components: id: id value: value key: key - - configuration: '{}' + - configuration: + key: configuration optional: true type: type items: @@ -2685,6 +3839,8 @@ components: itemSearchUrl: itemSearchUrl properties: configuration: + additionalProperties: + type: string description: Configuration parameters for the required input. type: object details: @@ -2720,8 +3876,20 @@ components: type: string Installments: example: - value: 6 + plan: regular + value: 7 properties: + plan: + description: |- + Defines the type of installment plan. If not set, defaults to **regular**. + + Possible values: + * **regular** + * **revolving** + enum: + - regular + - revolving + type: string value: description: |- Defines the number of installments. Its value needs to be greater than zero. @@ -2742,23 +3910,78 @@ components: name: description: The display name. type: string - LineItem: - example: - quantity: 7 - amountExcludingTax: 5 - taxPercentage: 3 - description: description - id: id - amountIncludingTax: 2 - taxAmount: 9 - taxCategory: High + KlarnaDetails: properties: - amountExcludingTax: - description: Item amount excluding the tax, in minor units. - format: int64 - type: integer - amountIncludingTax: - description: Item amount including the tax, in minor units. + bankAccount: + type: string + billingAddress: + type: string + deliveryAddress: + type: string + installmentConfigurationKey: + type: string + personalDetails: + type: string + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + separateDeliveryAddress: + type: string + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: openinvoice + description: '**klarna**' + enum: + - klarna + - klarnapayments + - klarnapayments_account + - klarnapayments_b2b + - klarna_paynow + - klarna_account + - klarna_b2b + type: string + required: + - type + LianLianPayDetails: + properties: + telephoneNumber: + type: string + type: + description: '**lianlianpay**' + enum: + - lianlianpay_ebanking_enterprise + - lianlianpay_ebanking_credit + - lianlianpay_ebanking_debit + type: string + required: + - telephoneNumber + - type + LineItem: + example: + quantity: 1 + amountExcludingTax: 0 + imageUrl: imageUrl + taxPercentage: 5 + description: description + id: id + amountIncludingTax: 6 + productUrl: productUrl + taxAmount: 5 + taxCategory: High + properties: + amountExcludingTax: + description: Item amount excluding the tax, in minor units. + format: int64 + type: integer + amountIncludingTax: + description: Item amount including the tax, in minor units. format: int64 type: integer description: @@ -2767,6 +3990,12 @@ components: id: description: ID of the line item. type: string + imageUrl: + description: Link to the picture of the purchased item. + type: string + productUrl: + description: Link to the purchased item. + type: string quantity: description: Number of items. format: int64 @@ -2787,6 +4016,39 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + MasterpassDetails: + properties: + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + masterpassTransactionId: + description: The Masterpass transaction ID. + type: string + type: + default: masterpass + description: '**masterpass**' + type: string + required: + - masterpassTransactionId + - type + MbwayDetails: + properties: + shopperEmail: + type: string + telephoneNumber: + type: string + type: + default: mbway + description: '**mbway**' + type: string + required: + - shopperEmail + - telephoneNumber + - type MerchantDevice: example: reference: reference @@ -2810,9 +4072,9 @@ components: preOrderDate: 2000-01-23T04:56:07.000+00:00 giftCardAmount: currency: currency - value: 0 + value: 5 deliveryEmail: deliveryEmail - giftCardCount: 4 + giftCardCount: 1 addressMatch: true deliveryAddressIndicator: shipToBillingAddress properties: @@ -2860,7 +4122,8 @@ components: giftCardAmount: $ref: '#/components/schemas/Amount' giftCardCount: - description: Number of individual prepaid or gift cards used for this purchase. + description: For prepaid or gift card purchase, total count of individual + prepaid or gift cards/codes purchased. format: int32 type: integer preOrderDate: @@ -2876,6 +4139,27 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + MobilePayDetails: + properties: + type: + default: mobilepay + description: '**mobilepay**' + type: string + required: + - type + MolPayDetails: + properties: + issuer: + type: string + type: + description: '**molpay**' + enum: + - molpay_ebanking_fpx_MY + - molpay_ebanking_TH + type: string + required: + - issuer + - type Name: example: firstName: firstName @@ -2909,159 +4193,473 @@ components: - firstName - gender - lastName - PaymentMethod: + OpenInvoiceDetails: + properties: + bankAccount: + type: string + billingAddress: + type: string + deliveryAddress: + type: string + installmentConfigurationKey: + type: string + personalDetails: + type: string + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + separateDeliveryAddress: + type: string + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: openinvoice + description: '**openinvoice**' + type: string + required: + - type + PayPalDetails: + properties: + orderID: + type: string + payerID: + type: string + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + subtype: + description: The type of flow to initiate. + enum: + - redirect + - sdk + type: string + type: + default: paypal + description: '**paypal**' + type: string + required: + - type + PayUUpiDetails: + properties: + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used for recurring payment only. + type: string + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + subscriptionDetails: + $ref: '#/components/schemas/SubscriptionDetails' + type: + default: payu_IN_upi + description: '**payu_IN_upi**' + type: string + virtualPaymentAddress: + description: The virtual payment address for UPI. + type: string + required: + - type + PaymentCompletionDetails: example: - supportsRecurring: true - brands: - - brands - - brands - configuration: '{}' - paymentMethodData: paymentMethodData - name: name - details: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - inputDetails: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true + cupsecureplus.smscode: cupsecureplus.smscode + orderID: orderID + payerID: payerID + oneTimePasscode: oneTimePasscode + threeds2.challengeResult: threeds2.challengeResult + redirectResult: redirectResult + threeds2.fingerprint: threeds2.fingerprint + payload: payload + billingToken: billingToken + paymentID: paymentID + MD: MD + PaReq: PaReq + PaRes: PaRes + paymentStatus: paymentStatus + facilitatorAccessToken: facilitatorAccessToken + properties: + MD: + description: A payment session identifier returned by the card issuer. + type: string + PaReq: + description: (3D) Payment Authentication Request data for the card issuer. + type: string + PaRes: + description: (3D) Payment Authentication Response data by the card issuer. + type: string + billingToken: + description: PayPal-generated token for recurring payments. + type: string + cupsecureplus.smscode: + description: The SMS verification code collected from the shopper. + type: string + facilitatorAccessToken: + description: PayPal-generated third party access token. + type: string + oneTimePasscode: + description: A random number sent to the mobile phone number of the shopper + to verify the payment. + type: string + orderID: + description: PayPal-assigned ID for the order. + type: string + payerID: + description: PayPal-assigned ID for the payer (shopper). + type: string + payload: + description: Payload appended to the `returnURL` as a result of the redirect. + type: string + paymentID: + description: PayPal-generated ID for the payment. + type: string + paymentStatus: + description: 'Value passed from the WeChat MiniProgram `wx.requestPayment` + **complete** callback. Possible values: any value starting with `requestPayment:`.' + type: string + redirectResult: + description: The result of the redirect as appended to the `returnURL`. + type: string + threeds2.challengeResult: + description: 'Base64-encoded string returned by the Component after the + challenge flow. It contains the following parameter: `transStatus`.' + type: string + threeds2.fingerprint: + description: 'Base64-encoded string returned by the Component after the + challenge flow. It contains the following parameter: `threeDSCompInd`.' + type: string + PaymentDetails: + properties: + type: + description: The payment method type. + type: string + required: + - type + PaymentLinkResource: + example: + splits: + - reference: reference + amount: + currency: currency + value: 7 + description: description + type: BalanceAccount + account: account + - reference: reference + amount: + currency: currency + value: 7 + description: description + type: BalanceAccount + account: account + description: description + lineItems: + - quantity: 1 + amountExcludingTax: 0 + imageUrl: imageUrl + taxPercentage: 5 + description: description + id: id + amountIncludingTax: 6 + productUrl: productUrl + taxAmount: 5 + taxCategory: High + - quantity: 1 + amountExcludingTax: 0 + imageUrl: imageUrl + taxPercentage: 5 + description: description + id: id + amountIncludingTax: 6 + productUrl: productUrl + taxAmount: 5 + taxCategory: High + reference: reference + shopperName: + firstName: firstName + lastName: lastName + gender: MALE + infix: infix + deliveryAddress: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode + countryCode: countryCode + recurringProcessingModel: CardOnFile + blockedPaymentMethods: + - blockedPaymentMethods + - blockedPaymentMethods + id: id + returnUrl: returnUrl + merchantOrderReference: merchantOrderReference + amount: + currency: currency + value: 5 + shopperEmail: shopperEmail + store: store + allowedPaymentMethods: + - allowedPaymentMethods + - allowedPaymentMethods + riskData: + fraudOffset: 2 + customFields: + key: customFields + profileReference: profileReference + clientData: clientData + expiresAt: expiresAt + url: url + reusable: true + storePaymentMethod: true + merchantAccount: merchantAccount + deliverAt: 2000-01-23T04:56:07.000+00:00 + billingAddress: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode + shopperLocale: shopperLocale + applicationInfo: + adyenLibrary: + name: name + version: version + merchantApplication: + name: name + version: version + adyenPaymentSource: + name: name + version: version + merchantDevice: + reference: reference + os: os + osVersion: osVersion + shopperInteractionDevice: + os: os + osVersion: osVersion + locale: locale + externalPlatform: + name: name + integrator: integrator + version: version + shopperReference: shopperReference + status: active + properties: + allowedPaymentMethods: + description: |- + List of payments methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). + + Example: `"allowedPaymentMethods":["ideal","giropay"]` + items: + type: string + type: array + amount: + $ref: '#/components/schemas/Amount' + applicationInfo: + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + $ref: '#/components/schemas/Address' + blockedPaymentMethods: + description: |- + List of payments methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). + + Example: `"blockedPaymentMethods":["ideal","giropay"]` + items: + type: string + type: array + countryCode: + description: The shopper's two-letter country code. + type: string + deliverAt: + description: The date and time the purchased goods should be delivered. + In ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. + format: date-time + type: string + deliveryAddress: + $ref: '#/components/schemas/Address' + description: + description: |- + A short description visible on the payment page. + Maximum length: 280 characters. + type: string + expiresAt: + description: The date that the payment link expires, in ISO 8601 format. + For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum + expiry date should be 30 days from when the payment link is created. If + not provided, the default expiry is set to 24 hours after the payment + link is created. + type: string + id: + description: A unique identifier of the payment link. + readOnly: true + type: string + lineItems: + description: |- + Price and product information about the purchased items, to be included on the invoice sent to the shopper. + This parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip. + items: + $ref: '#/components/schemas/LineItem' + type: array + merchantAccount: + description: The merchant account identifier for which the payment link + is created. + type: string + merchantOrderReference: + description: This reference allows linking multiple transactions to each + other for reporting purposes (for example, order auth-rate). The reference + should be unique per billing cycle. + type: string + recurringProcessingModel: + description: | + Defines a recurring payment type. + Allowed values: + * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. + * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. + * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + reference: + description: A reference that is used to uniquely identify the payment in + future communications about the payment status. + type: string + returnUrl: + description: |- + Website URL used for redirection after payment is completed. + If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL. + type: string + reusable: + description: Indicates whether the payment link can be reused for multiple + payments. If not provided, this defaults to **false** which means the + link can be used for one successful payment only. + type: boolean + riskData: + $ref: '#/components/schemas/RiskData' + shopperEmail: + description: The shopper's email address. + type: string + shopperLocale: + description: |- + The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`. + + For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/checkout/pay-by-link#language-and-localization). + type: string + shopperName: + $ref: '#/components/schemas/Name' + shopperReference: + description: A unique identifier for the shopper (for example, user ID or + account ID). + type: string + splits: + description: Information on how the payment should be split between accounts + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: |- + Status of the payment link. Possible values: + * **active** + * **completed** + * **expired** + enum: + - active + - completed + - expired + type: string + store: + description: The physical store, for which this payment is processed. + type: string + storePaymentMethod: + description: When this is set to **true** and the `shopperReference` is + provided, the payment details will be stored. + type: boolean + url: + description: The URL at which the shopper can complete the payment. + readOnly: true + type: string + required: + - amount + - id + - merchantAccount + - reference + - status + - url + PaymentMethod: + example: + brands: + - brands + - brands + configuration: + key: configuration + name: name + details: + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true type: type items: - name: name @@ -3079,9 +4677,11 @@ components: value: value key: key itemSearchUrl: itemSearchUrl - - configuration: '{}' + - configuration: + key: configuration details: - - configuration: '{}' + - configuration: + key: configuration optional: true type: type items: @@ -3091,7 +4691,8 @@ components: id: id value: value key: key - - configuration: '{}' + - configuration: + key: configuration optional: true type: type items: @@ -3103,7 +4704,8 @@ components: key: key optional: true inputDetails: - - configuration: '{}' + - configuration: + key: configuration optional: true type: type items: @@ -3113,7 +4715,8 @@ components: id: id value: value key: key - - configuration: '{}' + - configuration: + key: configuration optional: true type: type items: @@ -3132,18 +4735,142 @@ components: value: value key: key itemSearchUrl: itemSearchUrl - type: type - group: - paymentMethodData: paymentMethodData - name: name - type: type + inputDetails: + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + fundingSource: debit + type: type + brand: brand + group: + paymentMethodData: paymentMethodData + name: name + type: type properties: + brand: + description: 'Brand for the selected gift card. For example: plastix, hmclub.' + type: string brands: description: 'List of possible brands. For example: visa, mc.' items: type: string type: array configuration: + additionalProperties: + type: string description: The configuration of the payment method. type: object details: @@ -3152,6 +4879,11 @@ components: items: $ref: '#/components/schemas/InputDetail' type: array + fundingSource: + description: The funding source of the payment method. + enum: + - debit + type: string group: $ref: '#/components/schemas/PaymentMethodGroup' inputDetails: @@ -3164,13 +4896,6 @@ components: name: description: The displayable name of this payment method. type: string - paymentMethodData: - description: Echo data required to send in next calls. - type: string - supportsRecurring: - description: Indicates whether this payment method supports tokenization - or not. - type: boolean type: description: The unique payment method code. type: string @@ -3190,442 +4915,891 @@ components: type: description: The unique code of the group. type: string - PaymentMethodACH: - properties: - type: - description: Must be set to **ach**. - type: string - bankAccount: - description: The bank account, from which the funds should be deducted. - type: string - required: - - bankAccount - - type - PaymentMethodCard: + PaymentMethodsRequest: + example: + amount: + currency: currency + value: 5 + merchantAccount: merchantAccount + countryCode: countryCode + splitCardFundingSources: false + channel: iOS + additionalData: "" + blockedPaymentMethods: + - blockedPaymentMethods + - blockedPaymentMethods + shopperLocale: shopperLocale + store: store + allowedPaymentMethods: + - allowedPaymentMethods + - allowedPaymentMethods + order: + orderData: orderData + pspReference: pspReference + shopperReference: shopperReference properties: - type: - description: Must be set to **scheme**. - type: string - cvc: + additionalData: + anyOf: + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' description: |- - The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: - * CVV2/CVC2 – length: 3 digits - * CID – length: 4 digits - maxLength: 20 - minLength: 1 - type: string - expiryMonth: + This field contains additional data, which may be required for a particular payment request. + + The `additionalData` object consists of entries, each of which includes the key and value. + allowedPaymentMethods: description: |- - The card expiry month. - Format: 2 digits, zero-padded for single digits. For example: - * 03 = March - * 11 = November - maxLength: 2 - minLength: 1 - type: string - expiryYear: + List of payments methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). + + Example: `"allowedPaymentMethods":["ideal","giropay"]` + items: + type: string + type: array + amount: + $ref: '#/components/schemas/Amount' + blockedPaymentMethods: description: |- - The card expiry year. - Format: 4 digits. For example: 2020 - maxLength: 4 - minLength: 4 - type: string - holderName: - description: The name of the cardholder, as printed on the card. - maxLength: 50 - minLength: 1 - type: string - number: - description: The card number (4-19 characters). Do not use any separators. - maxLength: 19 - minLength: 4 - type: string - required: - - expiryMonth - - expiryYear - - holderName - - number - - type - PaymentMethodApplePay: - properties: - type: - description: Must be set to **applepay**. + List of payments methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). + + Example: `"blockedPaymentMethods":["ideal","giropay"]` + items: + type: string + type: array + channel: + description: |- + The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: + * iOS + * Android + * Web + enum: + - iOS + - Android + - Web type: string - applepay.token: - description: The stringified and base64 encoded paymentData retrieved from - the Apple framework. + countryCode: + description: The shopper's country code. type: string - required: - - applepay.token - - type - PaymentMethodAndroidPay: - properties: - type: - description: Must be set to **androidpay**. + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. type: string - androidpay.token: - description: The stringified and base64 encoded paymentData retrieved from - the Android framework. + order: + $ref: '#/components/schemas/CheckoutOrder' + shopperLocale: + description: The combination of a language code and a country code to specify + the language to be used in the payment. type: string - required: - - androidpay.token - - type - PaymentMethodAmazonPay: - properties: - type: - description: Must be set to **androidpay**. + shopperReference: + description: |- + Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. + > This field is required for recurring payments. type: string - amazonPayToken: - description: The stringified and base64 encoded paymentData retrieved from - the Amazon framework. + splitCardFundingSources: + default: false + description: Boolean value indicating whether the card payment method should + be split into separate debit and credit options. + type: boolean + store: + description: The physical store, for which this payment is processed. + maxLength: 16 + minLength: 1 type: string required: - - amazonPayToken - - type - PaymentMethodSchemeGiftCard: - properties: - type: - description: Must be set to **scheme**. - type: string - cvc: - description: |- - The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: - * CVV2/CVC2 – length: 3 digits - * CID – length: 4 digits - maxLength: 20 - minLength: 1 - type: string - expiryMonth: - description: |- - The card expiry month. - Format: 2 digits, zero-padded for single digits. For example: - * 03 = March - * 11 = November - maxLength: 2 - minLength: 1 - type: string - expiryYear: - description: |- - The card expiry year. - Format: 4 digits. For example: 2020 - maxLength: 4 - minLength: 4 - type: string - holderName: - description: The name of the cardholder, as printed on the card. - maxLength: 50 - minLength: 1 - type: string - number: - description: The card number (4-19 characters). Do not use any separators. - maxLength: 19 - minLength: 4 - type: string - encryptedSecurityCode: - description: |- - The encrypted [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: - * CVV2/CVC2 – length: 3 digits - * CID – length: 4 digits - maxLength: 20 - minLength: 1 - type: string - encryptedExpiryMonth: - description: |- - The encrypted card expiry month. - Format: 2 digits, zero-padded for single digits. For example: - * 03 = March - * 11 = November - maxLength: 2 - minLength: 1 - type: string - encryptedExpiryYear: - description: |- - The encrypted card expiry year. - Format: 4 digits. For example: 2020 - maxLength: 4 - minLength: 4 - type: string - encryptedCardNumber: - description: The encrypted card number (4-19 characters). Do not use any - separators. - maxLength: 19 - minLength: 4 - type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear - - encryptedSecurityCode - - expiryMonth - - expiryYear - - holderName - - number - - type - PaymentMethodDotpay: - properties: - type: - description: Must be set to **dotpay**. - type: string - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - required: - - issuer - - type - PaymentMethodDragonpayEBanking: - properties: - type: - description: Must be set to **dragonpay_ebanking**. - type: string - issuer: - description: The Dragonpay issuer value of the shopper's selected bank. - Set this to an **id** of a Dragonpay issuer to preselect it. - type: string - required: - - issuer - - type - PaymentMethodDragonpayOtcBanking: - properties: - type: - description: Must be set to **dragonpay_otc_banking**. - type: string - issuer: - description: The Dragonpay issuer value of the shopper's selected bank. - Set this to an **id** of a Dragonpay issuer to preselect it. - type: string - required: - - issuer - - type - PaymentMethodDragonpayOtcNonBanking: - properties: - type: - description: Must be set to **dragonpay_otc_non_banking**. - type: string - issuer: - description: The Dragonpay issuer value of the shopper's selected bank. - Set this to an **id** of a Dragonpay issuer to preselect it. - type: string - required: - - issuer - - type - PaymentMethodDragonpayOtcPhilippines: - properties: - type: - description: Must be set to **dragonpay_otc_philippines**. - type: string - issuer: - description: The Dragonpay issuer value of the shopper's selected bank. - Set this to an **id** of a Dragonpay issuer to preselect it. - type: string - required: - - issuer - - type - PaymentMethodGiropay: - properties: - type: - description: Must be set to **giropay**. - type: string - bic: - description: The bank identifier code (BIC) of the selected issuing bank. - type: string - required: - - bic - - type - PaymentMethodIDeal: - properties: - type: - description: Must be set to **dotpay**. - type: string - issuer: - description: The iDEAL issuer value of the shopper's selected bank. Set - this to an **id** of an iDeal issuer to preselect it. - type: string - required: - - issuer - - type - PaymentMethodLianLianPayEbankingEnterprise: - properties: - type: - description: Must be set to **lianlianpay_ebanking_enterprise**. - type: string - telephoneNumber: - description: The shopper's telephone number. - type: string - required: - - telephoneNumber - - type - PaymentMethodLianLianPayEbankingCredit: - properties: - type: - description: Must be set to **lianlianpay_ebanking_credit**. - type: string - telephoneNumber: - description: The shopper's telephone number. - type: string - required: - - telephoneNumber - - type - PaymentMethodLianLianPayEbankingDebit: - properties: - type: - description: Must be set to **lianlianpay_ebanking_debit**. - type: string - telephoneNumber: - description: The shopper's telephone number. - type: string - required: - - telephoneNumber - - type - PaymentMethodMOLpayEBankingMalaysia: - properties: - type: - description: Must be set to **molpay_ebanking_fpx_MY**. - type: string - issuer: - description: The MOLpay issuer value of the shopper's selected bank. Set - this to an **id** of a MOLpay issuer to preselect it. - type: string - required: - - issuer - - type - PaymentMethodMOLpayEBankingThailand: - properties: - type: - description: Must be set to **molpay_ebanking_TH**. - type: string - issuer: - description: The MOLpay issuer value of the shopper's selected bank. Set - this to an **id** of a MOLpay issuer to preselect it. - type: string - required: - - issuer - - type - PaymentMethodMOLpayEBankingVietnam: - properties: - type: - description: Must be set to **molpay_ebanking_VN**. - type: string - issuer: - description: The MOLpay issuer value of the shopper's selected bank. Set - this to an **id** of a MOLpay issuer to preselect it. - type: string - required: - - issuer - - type - PaymentMethodPayWithGoogle: - properties: - type: - description: Must be set to **paywithgoogle**. - type: string - paywithgoogle.token: - description: The stringified and base64 encoded paymentData retrieved from - the Google framework. - type: string - googlePayToken: - description: The stringified and base64 encoded paymentData retrieved from - the Google framework. - type: string - googlePayCardNetwork: - description: The card type provided by the shopper. - type: string - required: - - googlePayCardNetwork - - googlePayToken - - paywithgoogle.token - PaymentMethodQIWIWallet: - properties: - type: - description: Must be set to **qiwiwallet**. - type: string - qiwiwallet.telephoneNumberPrefix: - description: The shopper's telephone number prefix. - type: string - qiwiwallet.telephoneNumber: - description: The shopper's telephone number. - type: string - required: - - qiwiwallet.telephoneNumber - - qiwiwallet.telephoneNumberPrefix - - type - PaymentMethodSamsungpay: - properties: - type: - description: Must be set to **samsungpay**. - type: string - samsungpay.token: - description: The stringified and base64 encoded paymentData retrieved from - the Samsung framework. - type: string - required: - - samsungpay.token - - type - PaymentMethodSepaDirectDebit: - properties: - type: - description: Must be set to **sepadirectdebit**. - type: string - sepa.ibanNumber: - description: The shopper's international bank account number (IBAN). - type: string - sepa.ownerName: - description: The name on the SEPA bank account. - type: string - required: - - sepa.ibanNumber - - sepa.ownerName - - type - PaymentMethodVipps: - properties: - type: - description: Must be set to **vipps**. - type: string - telephoneNumber: - description: The shopper's telephone number. - type: string - required: - - telephoneNumber - - type - PaymentMethodsGroup: + - merchantAccount + - reference + PaymentMethodsResponse: example: - groupType: groupType - types: - - types - - types - name: name + paymentMethods: + - brands: + - brands + - brands + configuration: + key: configuration + name: name + details: + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + inputDetails: + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + fundingSource: debit + type: type + brand: brand + group: + paymentMethodData: paymentMethodData + name: name + type: type + - brands: + - brands + - brands + configuration: + key: configuration + name: name + details: + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + inputDetails: + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + fundingSource: debit + type: type + brand: brand + group: + paymentMethodData: paymentMethodData + name: name + type: type + storedPaymentMethods: + - lastFour: lastFour + holderName: holderName + expiryMonth: expiryMonth + name: name + shopperEmail: shopperEmail + expiryYear: expiryYear + id: id + supportedShopperInteractions: + - supportedShopperInteractions + - supportedShopperInteractions + type: type + brand: brand + - lastFour: lastFour + holderName: holderName + expiryMonth: expiryMonth + name: name + shopperEmail: shopperEmail + expiryYear: expiryYear + id: id + supportedShopperInteractions: + - supportedShopperInteractions + - supportedShopperInteractions + type: type + brand: brand properties: - groupType: - description: The type to submit for any payment method in this group. - type: string - name: - description: The human-readable name of this group. - type: string - types: - description: The types of payment methods that belong in this group. + paymentMethods: + description: Detailed list of payment methods required to generate payment + forms. items: - type: string + $ref: '#/components/schemas/PaymentMethod' type: array - PaymentMethodsRequest: + storedPaymentMethods: + description: List of all stored payment methods. + items: + $ref: '#/components/schemas/StoredPaymentMethod' + type: array + PaymentRequest: example: + dccQuote: + reference: reference + validTill: 2000-01-23T04:56:07.000+00:00 + signature: signature + accountType: accountType + buy: + currency: currency + value: 5 + sell: + currency: currency + value: 5 + interbank: + currency: currency + value: 5 + source: source + type: type + basePoints: 2 + account: account + baseAmount: + currency: currency + value: 5 + metadata: + key: metadata + sessionValidity: sessionValidity + splits: + - reference: reference + amount: + currency: currency + value: 7 + description: description + type: BalanceAccount + account: account + - reference: reference + amount: + currency: currency + value: 7 + description: description + type: BalanceAccount + account: account + deviceFingerprint: deviceFingerprint + redirectToIssuerMethod: redirectToIssuerMethod + channel: iOS + mcc: mcc + threeDSAuthenticationOnly: false + merchantRiskIndicator: + deliveryTimeframe: electronicDelivery + reorderItems: true + preOrderPurchase: true + preOrderDate: 2000-01-23T04:56:07.000+00:00 + giftCardAmount: + currency: currency + value: 5 + deliveryEmail: deliveryEmail + giftCardCount: 1 + addressMatch: true + deliveryAddressIndicator: shipToBillingAddress + lineItems: + - quantity: 1 + amountExcludingTax: 0 + imageUrl: imageUrl + taxPercentage: 5 + description: description + id: id + amountIncludingTax: 6 + productUrl: productUrl + taxAmount: 5 + taxCategory: High + - quantity: 1 + amountExcludingTax: 0 + imageUrl: imageUrl + taxPercentage: 5 + description: description + id: id + amountIncludingTax: 6 + productUrl: productUrl + taxAmount: 5 + taxCategory: High + reference: reference + deliveryAddress: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode + installments: + plan: regular + value: 7 + recurringProcessingModel: CardOnFile + additionalData: "" + order: + orderData: orderData + pspReference: pspReference + trustedShopper: true + enablePayOut: true + fraudOffset: 6 + entityType: NaturalPerson + shopperEmail: shopperEmail + enableOneClick: true + threeDS2RequestData: + notificationURL: notificationURL + whiteListStatus: whiteListStatus + authenticationOnly: false + sdkMaxTimeout: 1 + sdkEncData: sdkEncData + acquirerBIN: acquirerBIN + mcc: mcc + threeDSRequestorID: threeDSRequestorID + deviceChannel: deviceChannel + deviceRenderOptions: + sdkUiType: + - multiSelect + - multiSelect + sdkInterface: both + sdkEphemPubKey: + kty: kty + crv: crv + x: x + y: "y" + merchantName: merchantName + transactionType: goodsOrServicePurchase + threeDSRequestorURL: threeDSRequestorURL + sdkReferenceNumber: sdkReferenceNumber + challengeIndicator: noPreference + threeDSRequestorName: threeDSRequestorName + acquirerMerchantID: acquirerMerchantID + sdkAppID: sdkAppID + messageVersion: 2.1.0 + threeDSCompInd: threeDSCompInd + sdkTransID: sdkTransID + orderReference: orderReference + paymentMethod: "" + shopperLocale: shopperLocale + captureDelayHours: 0 + applicationInfo: + adyenLibrary: + name: name + version: version + merchantApplication: + name: name + version: version + adyenPaymentSource: + name: name + version: version + merchantDevice: + reference: reference + os: os + osVersion: osVersion + shopperInteractionDevice: + os: os + osVersion: osVersion + locale: locale + externalPlatform: + name: name + integrator: integrator + version: version + browserInfo: + acceptHeader: acceptHeader + screenWidth: 7 + javaEnabled: true + screenHeight: 2 + timeZoneOffset: 9 + javaScriptEnabled: true + language: language + userAgent: userAgent + colorDepth: 5 + shopperReference: shopperReference + shopperStatement: shopperStatement + recurringFrequency: recurringFrequency + telephoneNumber: telephoneNumber + socialSecurityNumber: socialSecurityNumber + origin: origin + shopperIP: shopperIP + recurringExpiry: recurringExpiry + shopperName: + firstName: firstName + lastName: lastName + gender: MALE + infix: infix + countryCode: countryCode + shopperInteraction: Ecommerce + company: + registrationNumber: registrationNumber + registryLocation: registryLocation + taxId: taxId + name: name + type: type + homepage: homepage + deliveryDate: 2000-01-23T04:56:07.000+00:00 + returnUrl: returnUrl + conversionId: conversionId + accountInfo: + passwordChangeDate: 2000-01-23T04:56:07.000+00:00 + paymentAccountIndicator: notApplicable + suspiciousActivity: true + deliveryAddressUsageIndicator: thisTransaction + pastTransactionsYear: 1 + accountType: notApplicable + homePhone: homePhone + paymentAccountAge: 2000-01-23T04:56:07.000+00:00 + accountAgeIndicator: notApplicable + deliveryAddressUsageDate: 2000-01-23T04:56:07.000+00:00 + accountChangeDate: 2000-01-23T04:56:07.000+00:00 + accountCreationDate: 2000-01-23T04:56:07.000+00:00 + mobilePhone: mobilePhone + pastTransactionsDay: 6 + accountChangeIndicator: thisTransaction + passwordChangeIndicator: notApplicable + addCardAttemptsDay: 0 + workPhone: workPhone + purchasesLast6Months: 5 + merchantOrderReference: merchantOrderReference amount: currency: currency - value: 0 - enableRealTimeUpdate: true - merchantAccount: merchantAccount - countryCode: countryCode - channel: iOS - additionalData: "" - blockedPaymentMethods: - - blockedPaymentMethods - - blockedPaymentMethods - shopperLocale: shopperLocale + value: 5 + redirectFromIssuerMethod: redirectFromIssuerMethod + dateOfBirth: 2000-01-23T04:56:07.000+00:00 store: store - allowedPaymentMethods: - - allowedPaymentMethods - - allowedPaymentMethods - threeDSAuthenticationOnly: true - shopperReference: shopperReference + riskData: + fraudOffset: 2 + customFields: + key: customFields + profileReference: profileReference + clientData: clientData + storePaymentMethod: true + merchantAccount: merchantAccount + billingAddress: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode + enableRecurring: true + mpiData: + cavv: cavv + authenticationResponse: "Y" + xid: xid + cavvAlgorithm: cavvAlgorithm + dsTransID: dsTransID + directoryResponse: A + eci: eci + threeDSVersion: threeDSVersion properties: + accountInfo: + $ref: '#/components/schemas/AccountInfo' additionalData: anyOf: - $ref: '#/components/schemas/AdditionalDataCommon' @@ -3635,36 +5809,35 @@ components: - $ref: '#/components/schemas/AdditionalDataLevel23' - $ref: '#/components/schemas/AdditionalDataLodging' - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' - $ref: '#/components/schemas/AdditionalDataRatepay' - $ref: '#/components/schemas/AdditionalDataRetry' - $ref: '#/components/schemas/AdditionalDataRisk' - $ref: '#/components/schemas/AdditionalDataRiskStandalone' - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' description: |- This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. - allowedPaymentMethods: - description: |- - List of payments methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). - - Example: `"allowedPaymentMethods":["ideal","giropay"]` - items: - type: string - type: array amount: $ref: '#/components/schemas/Amount' - blockedPaymentMethods: - description: |- - List of payments methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). - - Example: `"blockedPaymentMethods":["ideal","giropay"]` - items: - type: string - type: array + applicationInfo: + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + $ref: '#/components/schemas/Address' + browserInfo: + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer channel: description: |- - The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: + The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. + + Possible values: * iOS * Android * Web @@ -3673,591 +5846,321 @@ components: - Android - Web type: string + company: + $ref: '#/components/schemas/Company' + conversionId: + description: Conversion ID that corresponds to the Id generated for tracking + user payment journey. + type: string countryCode: - description: The shopper's country code. + description: |- + The shopper country. + + Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + Example: NL or DE type: string - enableRealTimeUpdate: - deprecated: true - description: Choose if a specific transaction should use the Real-time Account - Updater, regardless of other settings. + dateOfBirth: + description: |- + The shopper's date of birth. + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + format: date-time + type: string + dccQuote: + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + $ref: '#/components/schemas/Address' + deliveryDate: + description: |- + The date and time the purchased goods should be delivered. + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + Example: 2017-07-17T13:42:40.428+01:00 + format: date-time + type: string + deviceFingerprint: + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + type: string + enableOneClick: + description: When true and `shopperReference` is provided, the shopper will + be asked if the payment details should be stored for future one-click + payments. + type: boolean + enablePayOut: + description: When true and `shopperReference` is provided, the payment details + will be tokenized for payouts. + type: boolean + enableRecurring: + description: When true and `shopperReference` is provided, the payment details + will be tokenized for recurring payments. type: boolean + entityType: + description: The type of the entity the payment is processed for. + enum: + - NaturalPerson + - CompanyName + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + installments: + $ref: '#/components/schemas/Installments' + lineItems: + description: |- + Price and product information about the purchased items, to be included on the invoice sent to the shopper. + > This field is required for Klarna, AfterPay, 3x 4x Oney, Zip and RatePay. + items: + $ref: '#/components/schemas/LineItem' + type: array + mcc: + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string merchantAccount: description: The merchant account identifier, with which you want to process the transaction. type: string + merchantOrderReference: + description: |- + This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. + The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. + > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + type: string + merchantRiskIndicator: + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + additionalProperties: + type: string + description: |- + Metadata consists of entries, each of which includes a key and a value. + Limitations: Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". + type: object + mpiData: + $ref: '#/components/schemas/ThreeDSecureData' + order: + $ref: '#/components/schemas/CheckoutOrder' + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + origin: + description: |- + Required for the 3D Secure 2 `channel` **Web** integration. + + Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from. + type: string + paymentMethod: + description: The type and required details of a payment method to use. + oneOf: + - $ref: '#/components/schemas/ApplePayDetails' + - $ref: '#/components/schemas/SamsungPayDetails' + - $ref: '#/components/schemas/AndroidPayDetails' + - $ref: '#/components/schemas/VisaCheckoutDetails' + - $ref: '#/components/schemas/GooglePayDetails' + - $ref: '#/components/schemas/AmazonPayDetails' + - $ref: '#/components/schemas/MasterpassDetails' + - $ref: '#/components/schemas/StoredPaymentMethodDetails' + - $ref: '#/components/schemas/CardDetails' + - $ref: '#/components/schemas/PaymentDetails' + - $ref: '#/components/schemas/AchDetails' + - $ref: '#/components/schemas/KlarnaDetails' + - $ref: '#/components/schemas/IdealDetails' + - $ref: '#/components/schemas/PayPalDetails' + - $ref: '#/components/schemas/SepaDirectDebitDetails' + - $ref: '#/components/schemas/QiwiWalletDetails' + - $ref: '#/components/schemas/VippsDetails' + - $ref: '#/components/schemas/MobilePayDetails' + - $ref: '#/components/schemas/CellulantDetails' + - $ref: '#/components/schemas/WeChatPayDetails' + - $ref: '#/components/schemas/WeChatPayMiniProgramDetails' + - $ref: '#/components/schemas/LianLianPayDetails' + - $ref: '#/components/schemas/MolPayDetails' + - $ref: '#/components/schemas/BillDeskOnlineDetails' + - $ref: '#/components/schemas/BillDeskWalletDetails' + - $ref: '#/components/schemas/PayUUpiDetails' + - $ref: '#/components/schemas/UpiDetails' + - $ref: '#/components/schemas/DotpayDetails' + - $ref: '#/components/schemas/EntercashDetails' + - $ref: '#/components/schemas/OpenInvoiceDetails' + - $ref: '#/components/schemas/DokuDetails' + - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/DragonpayDetails' + - $ref: '#/components/schemas/GiropayDetails' + - $ref: '#/components/schemas/BacsDirectDebitDetails' + - $ref: '#/components/schemas/BlikDetails' + - $ref: '#/components/schemas/MbwayDetails' + x-oneOf-name: PaymentRequestPaymentMethodOneOf + recurringExpiry: + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + type: string + recurringFrequency: + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + recurringProcessingModel: + description: | + Defines a recurring payment type. + Allowed values: + * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. + * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. + * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + redirectFromIssuerMethod: + description: Specifies the redirect method (GET or POST) when redirecting + back from the issuer. + type: string + redirectToIssuerMethod: + description: Specifies the redirect method (GET or POST) when redirecting + to the issuer. + type: string + reference: + description: |- + The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. + If you need to provide multiple references for a transaction, separate them with hyphens ("-"). + Maximum length: 80 characters. + type: string + returnUrl: + description: |- + The URL to return to in case of a redirection. + The format depends on the channel. This URL can have a maximum of 1024 characters. + * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. + Example: `https://your-company.com/checkout?shopperOrder=12xy` + * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). + Example: `my-app://` + * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). + Example: `my-app://your.package.name` + type: string + riskData: + $ref: '#/components/schemas/RiskData' + sessionValidity: + description: |- + The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. + + For example: 2020-07-18T15:42:40.428+01:00 + type: string + shopperEmail: + description: |- + The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. + > For 3D Secure 2 transactions, schemes require the `shopperEmail` for both `deviceChannel` **browser** and **app**. + type: string + shopperIP: + description: |- + The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). + > Required for 3D Secure 2 transactions. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new). + type: string + shopperInteraction: + description: |- + Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. + For the web service API, Adyen assumes Ecommerce shopper interaction by default. + + This field has the following possible values: + * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. + * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). + * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. + * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string shopperLocale: description: The combination of a language code and a country code to specify the language to be used in the payment. type: string + shopperName: + $ref: '#/components/schemas/Name' shopperReference: description: |- - The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). + Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. type: string + shopperStatement: + description: |- + The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. + type: string + socialSecurityNumber: + description: The shopper's social security number. + type: string + splits: + description: Information on how the payment should be split between accounts + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array store: description: The physical store, for which this payment is processed. maxLength: 16 minLength: 1 type: string + storePaymentMethod: + description: When true and `shopperReference` is provided, the payment details + will be stored. + type: boolean + telephoneNumber: + description: The shopper's telephone number. + type: string + threeDS2RequestData: + $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: + default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean + trustedShopper: + description: Set to true if the payment should be routed to a trusted MID. + type: boolean required: - - merchantAccount - - reference - PaymentMethodsResponse: - example: - oneClickPaymentMethods: - - storedDetails: - bank: - ownerName: ownerName - countryCode: countryCode - taxId: taxId - iban: iban - bankAccountNumber: bankAccountNumber - bankName: bankName - bankLocationId: bankLocationId - bic: bic - bankCity: bankCity - emailAddress: emailAddress - card: - cvc: cvc - number: number - holderName: holderName - startMonth: startMonth - issueNumber: issueNumber - expiryMonth: expiryMonth - startYear: startYear - expiryYear: expiryYear - supportsRecurring: true - brands: - - brands - - brands - configuration: '{}' - paymentMethodData: paymentMethodData - name: name - recurringDetailReference: recurringDetailReference - details: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - inputDetails: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - type: type - group: - paymentMethodData: paymentMethodData + - amount + - merchantAccount + - paymentMethod + - reference + - returnUrl + PaymentResponse: + example: + redirect: + data: + key: data + method: GET + url: url + amount: + currency: currency + value: 5 + outputDetails: + key: outputDetails + resultCode: AuthenticationFinished + fraudResult: + accountScore: 0 + results: + - accountScore: 6 name: name - type: type - - storedDetails: - bank: - ownerName: ownerName - countryCode: countryCode - taxId: taxId - iban: iban - bankAccountNumber: bankAccountNumber - bankName: bankName - bankLocationId: bankLocationId - bic: bic - bankCity: bankCity - emailAddress: emailAddress - card: - cvc: cvc - number: number - holderName: holderName - startMonth: startMonth - issueNumber: issueNumber - expiryMonth: expiryMonth - startYear: startYear - expiryYear: expiryYear - supportsRecurring: true - brands: - - brands - - brands - configuration: '{}' - paymentMethodData: paymentMethodData - name: name - recurringDetailReference: recurringDetailReference - details: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - inputDetails: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - type: type - group: - paymentMethodData: paymentMethodData + checkId: 1 + - accountScore: 6 name: name - type: type - paymentMethods: - - supportsRecurring: true - brands: - - brands - - brands - configuration: '{}' - paymentMethodData: paymentMethodData - name: name + checkId: 1 + refusalReasonCode: refusalReasonCode + paymentData: paymentData + action: "" + details: + - configuration: + key: configuration details: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -4266,51 +6169,9 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -4319,52 +6180,11 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl + optional: true inputDetails: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -4373,51 +6193,9 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -4426,117 +6204,32 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl type: type - group: - paymentMethodData: paymentMethodData - name: name - type: type - - supportsRecurring: true - brands: - - brands - - brands - configuration: '{}' - paymentMethodData: paymentMethodData - name: name + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration details: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true type: type items: - name: name @@ -4545,52 +6238,11 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl + optional: true inputDetails: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -4599,51 +6251,9 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -4652,71 +6262,154 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl - type: type - group: - paymentMethodData: paymentMethodData - name: name - type: type - groups: - - groupType: groupType - types: - - types - - types - name: name - - groupType: groupType - types: - - types - - types - name: name - storedPaymentMethods: - - lastFour: lastFour - holderName: holderName - expiryMonth: expiryMonth - name: name - shopperEmail: shopperEmail - expiryYear: expiryYear - id: id - supportedShopperInteractions: - - supportedShopperInteractions - - supportedShopperInteractions - type: type - brand: brand - - lastFour: lastFour - holderName: holderName - expiryMonth: expiryMonth - name: name - shopperEmail: shopperEmail - expiryYear: expiryYear - id: id - supportedShopperInteractions: - - supportedShopperInteractions - - supportedShopperInteractions type: type - brand: brand - properties: - groups: - description: Groups of payment methods. - items: - $ref: '#/components/schemas/PaymentMethodsGroup' - type: array - oneClickPaymentMethods: - description: Detailed list of one-click payment methods. - items: - $ref: '#/components/schemas/RecurringDetail' - type: array - paymentMethods: - description: Detailed list of payment methods required to generate payment - forms. items: - $ref: '#/components/schemas/PaymentMethod' - type: array - storedPaymentMethods: - description: List of all stored payment methods. + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + refusalReason: refusalReason + additionalData: "" + merchantReference: merchantReference + pspReference: pspReference + authentication: + key: authentication + order: + reference: reference + remainingAmount: + currency: currency + value: 5 + orderData: orderData + pspReference: pspReference + expiresAt: expiresAt + properties: + action: + description: Action to be taken for completing the payment. + oneOf: + - $ref: '#/components/schemas/CheckoutDonationAction' + - $ref: '#/components/schemas/CheckoutQrCodeAction' + - $ref: '#/components/schemas/CheckoutRedirectAction' + - $ref: '#/components/schemas/CheckoutSDKAction' + - $ref: '#/components/schemas/CheckoutThreeDS2ChallengeAction' + - $ref: '#/components/schemas/CheckoutThreeDS2FingerPrintAction' + - $ref: '#/components/schemas/CheckoutThreeDS2Action' + - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutVoucherAction' + - $ref: '#/components/schemas/CheckoutOneTimePasscodeAction' + x-oneOf-name: PaymentResponseActionOneOf + additionalData: + anyOf: + - $ref: '#/components/schemas/ResponseAdditionalDataCommon' + - $ref: '#/components/schemas/ResponseAdditionalData3DSecure' + - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress' + - $ref: '#/components/schemas/ResponseAdditionalDataCard' + - $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress' + - $ref: '#/components/schemas/ResponseAdditionalDataInstallments' + - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens' + - $ref: '#/components/schemas/ResponseAdditionalDataOpi' + - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' + - $ref: '#/components/schemas/ResponseAdditionalDataSepa' + description: This field contains additional data, which may be required + to return in a particular payment response. To choose data fields to be + returned, go to **Customer Area** > **Account** > **API URLs** > **Additional + data settings**. + amount: + $ref: '#/components/schemas/Amount' + authentication: + additionalProperties: + type: string + deprecated: true + description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` + values to be used in further calls to `/payments/details` endpoint. ' + type: object + x-deprecatedInVersion: 64 + x-deprecatedMessage: Use `action` instead. + details: + deprecated: true + description: When non-empty, contains all the fields that you must submit + to the `/payments/details` endpoint. items: - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/InputDetail' type: array - PaymentRequest: + x-deprecatedInVersion: 64 + fraudResult: + $ref: '#/components/schemas/FraudResult' + merchantReference: + description: |- + The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. + If you need to provide multiple references for a transaction, separate them with hyphens ("-"). + Maximum length: 80 characters. + type: string + order: + $ref: '#/components/schemas/CheckoutOrderResponse' + outputDetails: + additionalProperties: + type: string + deprecated: true + description: Contains the details that will be presented to the shopper. + type: object + x-deprecatedInVersion: 64 + x-deprecatedMessage: Use `action` instead. + paymentData: + deprecated: true + description: When non-empty, contains a value that you must submit to the + `/payments/details` endpoint. + type: string + x-deprecatedInVersion: 64 + x-deprecatedMessage: Use `action.paymentData` instead. + pspReference: + description: |- + Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + + > `pspReference` is returned only for non-redirect payment methods. + type: string + redirect: + $ref: '#/components/schemas/Redirect' + refusalReason: + description: |- + If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + + For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + type: string + refusalReasonCode: + description: Code that specifies the refusal reason. For more information, + see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + type: string + resultCode: + description: |- + The result of the payment. For more information, see [Result codes](https://docs.adyen.com/checkout/payment-result-codes). + + Possible values: + + * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. + * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). + * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. + * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. + * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. + * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. + * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. + * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. + * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. + * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. + * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. + * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused + type: string + PaymentSetupRequest: example: dccQuote: reference: reference @@ -4725,70 +6418,61 @@ components: accountType: accountType buy: currency: currency - value: 0 + value: 5 sell: currency: currency - value: 0 + value: 5 interbank: currency: currency - value: 0 + value: 5 source: source type: type - basePoints: 1 + basePoints: 2 account: account baseAmount: currency: currency - value: 0 - metadata: '{}' + value: 5 + metadata: + key: metadata sessionValidity: sessionValidity splits: - reference: reference amount: currency: currency - value: 2 + value: 7 description: description type: BalanceAccount account: account - reference: reference amount: currency: currency - value: 2 + value: 7 description: description type: BalanceAccount account: account - deviceFingerprint: deviceFingerprint - redirectToIssuerMethod: redirectToIssuerMethod channel: iOS mcc: mcc - threeDSAuthenticationOnly: true - merchantRiskIndicator: - deliveryTimeframe: electronicDelivery - reorderItems: true - preOrderPurchase: true - preOrderDate: 2000-01-23T04:56:07.000+00:00 - giftCardAmount: - currency: currency - value: 0 - deliveryEmail: deliveryEmail - giftCardCount: 4 - addressMatch: true - deliveryAddressIndicator: shipToBillingAddress + threeDSAuthenticationOnly: false lineItems: - - quantity: 7 - amountExcludingTax: 5 - taxPercentage: 3 + - quantity: 1 + amountExcludingTax: 0 + imageUrl: imageUrl + taxPercentage: 5 description: description id: id - amountIncludingTax: 2 - taxAmount: 9 + amountIncludingTax: 6 + productUrl: productUrl + taxAmount: 5 taxCategory: High - - quantity: 7 - amountExcludingTax: 5 - taxPercentage: 3 + - quantity: 1 + amountExcludingTax: 0 + imageUrl: imageUrl + taxPercentage: 5 description: description id: id - amountIncludingTax: 2 - taxAmount: 9 + amountIncludingTax: 6 + productUrl: productUrl + taxAmount: 5 taxCategory: High reference: reference deliveryAddress: @@ -4799,50 +6483,22 @@ components: street: street postalCode: postalCode installments: - value: 6 - recurringProcessingModel: CardOnFile + plan: regular + value: 7 additionalData: "" + blockedPaymentMethods: + - blockedPaymentMethods + - blockedPaymentMethods trustedShopper: true enablePayOut: true - fraudOffset: 2 + fraudOffset: 6 entityType: NaturalPerson shopperEmail: shopperEmail enableOneClick: true - threeDS2RequestData: - notificationURL: notificationURL - whiteListStatus: whiteListStatus - authenticationOnly: true - sdkMaxTimeout: 7 - sdkEncData: sdkEncData - acquirerBIN: acquirerBIN - mcc: mcc - threeDSRequestorID: threeDSRequestorID - deviceChannel: deviceChannel - deviceRenderOptions: - sdkUiType: - - multiSelect - - multiSelect - sdkInterface: Html - sdkEphemPubKey: - kty: kty - crv: crv - x: x - y: "y" - merchantName: merchantName - transactionType: goodsOrServicePurchase - threeDSRequestorURL: threeDSRequestorURL - sdkReferenceNumber: sdkReferenceNumber - challengeIndicator: noPreference - threeDSRequestorName: threeDSRequestorName - acquirerMerchantID: acquirerMerchantID - sdkAppID: sdkAppID - messageVersion: messageVersion - threeDSCompInd: threeDSCompInd - sdkTransID: sdkTransID orderReference: orderReference - paymentMethod: '{}' + sdkVersion: sdkVersion shopperLocale: shopperLocale - captureDelayHours: 3 + captureDelayHours: 0 applicationInfo: adyenLibrary: name: name @@ -4865,20 +6521,22 @@ components: name: name integrator: integrator version: version - browserInfo: - acceptHeader: acceptHeader - screenWidth: 7 - javaEnabled: true - screenHeight: 2 - timeZoneOffset: 9 - javaScriptEnabled: true - language: language - userAgent: userAgent - colorDepth: 5 shopperReference: shopperReference shopperStatement: shopperStatement recurringFrequency: recurringFrequency telephoneNumber: telephoneNumber + configuration: + cardHolderName: NONE + installments: + plan: regular + value: 7 + shopperInput: + deliveryAddress: editable + personalDetails: editable + billingAddress: editable + avs: + addressEditable: true + enabled: "yes" socialSecurityNumber: socialSecurityNumber origin: origin shopperIP: shopperIP @@ -4888,7 +6546,6 @@ components: lastName: lastName gender: MALE infix: infix - enableRealTimeUpdate: true countryCode: countryCode shopperInteraction: Ecommerce company: @@ -4901,35 +6558,21 @@ components: deliveryDate: 2000-01-23T04:56:07.000+00:00 returnUrl: returnUrl conversionId: conversionId - accountInfo: - passwordChangeDate: 2000-01-23T04:56:07.000+00:00 - paymentAccountIndicator: notApplicable - suspiciousActivity: true - deliveryAddressUsageIndicator: thisTransaction - pastTransactionsYear: 1 - accountType: notApplicable - homePhone: homePhone - paymentAccountAge: 2000-01-23T04:56:07.000+00:00 - accountAgeIndicator: notApplicable - deliveryAddressUsageDate: 2000-01-23T04:56:07.000+00:00 - accountChangeDate: 2000-01-23T04:56:07.000+00:00 - accountCreationDate: 2000-01-23T04:56:07.000+00:00 - mobilePhone: mobilePhone - pastTransactionsDay: 6 - accountChangeIndicator: thisTransaction - passwordChangeIndicator: notApplicable - addCardAttemptsDay: 0 - workPhone: workPhone - purchasesLast6Months: 5 merchantOrderReference: merchantOrderReference amount: currency: currency - value: 0 - redirectFromIssuerMethod: redirectFromIssuerMethod + value: 5 dateOfBirth: 2000-01-23T04:56:07.000+00:00 - store: store + allowedPaymentMethods: + - allowedPaymentMethods + - allowedPaymentMethods riskData: + fraudOffset: 2 + customFields: + key: customFields + profileReference: profileReference clientData: clientData + token: token storePaymentMethod: true merchantAccount: merchantAccount billingAddress: @@ -4940,18 +6583,7 @@ components: street: street postalCode: postalCode enableRecurring: true - mpiData: - cavv: cavv - authenticationResponse: "Y" - xid: xid - cavvAlgorithm: cavvAlgorithm - dsTransID: dsTransID - directoryResponse: A - eci: eci - threeDSVersion: threeDSVersion properties: - accountInfo: - $ref: '#/components/schemas/AccountInfo' additionalData: anyOf: - $ref: '#/components/schemas/AdditionalDataCommon' @@ -4961,23 +6593,39 @@ components: - $ref: '#/components/schemas/AdditionalDataLevel23' - $ref: '#/components/schemas/AdditionalDataLodging' - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' - $ref: '#/components/schemas/AdditionalDataRatepay' - $ref: '#/components/schemas/AdditionalDataRetry' - $ref: '#/components/schemas/AdditionalDataRisk' - $ref: '#/components/schemas/AdditionalDataRiskStandalone' - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' description: |- This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + allowedPaymentMethods: + description: |- + List of payments methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). + + Example: `"allowedPaymentMethods":["ideal","giropay"]` + items: + type: string + type: array amount: $ref: '#/components/schemas/Amount' applicationInfo: $ref: '#/components/schemas/ApplicationInfo' billingAddress: $ref: '#/components/schemas/Address' - browserInfo: - $ref: '#/components/schemas/BrowserInfo' + blockedPaymentMethods: + description: |- + List of payments methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). + + Example: `"blockedPaymentMethods":["ideal","giropay"]` + items: + type: string + type: array captureDelayHours: description: The delay between the authorisation and scheduled auto-capture, specified in hours. @@ -4998,6 +6646,8 @@ components: type: string company: $ref: '#/components/schemas/Company' + configuration: + $ref: '#/components/schemas/Configuration' conversionId: description: Conversion ID that corresponds to the Id generated for tracking user payment journey. @@ -5029,10 +6679,6 @@ components: Example: 2017-07-17T13:42:40.428+01:00 format: date-time type: string - deviceFingerprint: - description: A string containing the shopper's device fingerprint. For more - information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). - type: string enableOneClick: description: When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click @@ -5042,11 +6688,6 @@ components: description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean - enableRealTimeUpdate: - deprecated: true - description: Choose if a specific transaction should use the Real-time Account - Updater, regardless of other settings. - type: boolean enableRecurring: description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. @@ -5067,7 +6708,7 @@ components: lineItems: description: |- Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for Klarna, AfterPay, and RatePay. + > This field is required for Klarna, AfterPay, 3x 4x Oney, Zip and RatePay. items: $ref: '#/components/schemas/LineItem' type: array @@ -5086,15 +6727,13 @@ components: The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. type: string - merchantRiskIndicator: - $ref: '#/components/schemas/MerchantRiskIndicator' metadata: + additionalProperties: + type: string description: |- Metadata consists of entries, each of which includes a key and a value. Limitations: Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". type: object - mpiData: - $ref: '#/components/schemas/ThreeDSecureData' orderReference: description: When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple @@ -5103,14 +6742,10 @@ components: type: string origin: description: |- - Required for the 3D Secure 2 `channel` **Web** integration. + Required for the Web integration. - Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from. + Set this parameter to the origin URL of the page that you are loading the SDK from. type: string - paymentMethod: - description: The collection that contains the type of the payment method - and its specific information (e.g. `idealIssuer`). - type: object recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. @@ -5119,26 +6754,6 @@ components: description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string - recurringProcessingModel: - description: | - Defines a recurring payment type. - Allowed values: - * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. - * `CardOnFile` – Card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. - * `UnscheduledCardOnFile` – A transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. - enum: - - CardOnFile - - Subscription - - UnscheduledCardOnFile - type: string - redirectFromIssuerMethod: - description: Specifies the redirect method (GET or POST) when redirecting - back from the issuer. - type: string - redirectToIssuerMethod: - description: Specifies the redirect method (GET or POST) when redirecting - to the issuer. - type: string reference: description: |- The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. @@ -5158,8 +6773,15 @@ components: type: string riskData: $ref: '#/components/schemas/RiskData' + sdkVersion: + description: The version of the SDK you are using (for Web SDK integrations + only). + type: string sessionValidity: - description: The maximum validity of the session. + description: |- + The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. + + For example: 2020-07-18T15:42:40.428+01:00 type: string shopperEmail: description: |- @@ -5195,18 +6817,20 @@ components: $ref: '#/components/schemas/Name' shopperReference: description: |- - The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). + Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. type: string shopperStatement: - description: The text to appear on the shopper's bank statement. + description: |- + The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. type: string socialSecurityNumber: description: The shopper's social security number. type: string splits: description: Information on how the payment should be split between accounts - when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5214,86 +6838,110 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean - store: - description: The physical store, for which this payment is processed. - maxLength: 16 - minLength: 1 - type: string telephoneNumber: description: The shopper's telephone number. type: string - threeDS2RequestData: - $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: + default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean + token: + description: |- + The token obtained when initializing the SDK. + + > This parameter is required for iOS and Android; not required for Web. + type: string trustedShopper: description: Set to true if the payment should be routed to a trusted MID. type: boolean required: - amount + - countryCode - merchantAccount - - paymentMethod - reference - returnUrl - PaymentResponse: + PaymentSetupResponse: example: - redirect: - data: '{}' - method: GET - url: url - amount: - currency: currency - value: 0 - outputDetails: '{}' - resultCode: AuthenticationFinished - fraudResult: - accountScore: 0 - results: - - accountScore: 6 - name: name - checkId: 1 - - accountScore: 6 - name: name - checkId: 1 - refusalReasonCode: refusalReasonCode - paymentData: paymentData - action: - surcharge: - currency: currency - value: 0 - instructionsUrl: instructionsUrl - qrCodeData: qrCodeData - data: '{}' - method: method - downloadUrl: downloadUrl - shopperEmail: shopperEmail - type: await - expiresAt: expiresAt - issuer: issuer - url: url - merchantName: merchantName - token: token - reference: reference - totalAmount: - currency: currency - value: 0 - shopperName: shopperName - maskedTelephoneNumber: maskedTelephoneNumber - initialAmount: - currency: currency - value: 0 - paymentData: paymentData - alternativeReference: alternativeReference - merchantReference: merchantReference - paymentMethodType: paymentMethodType - entity: entity - details: - - configuration: '{}' + recurringDetails: + - storedDetails: + bank: + ownerName: ownerName + countryCode: countryCode + taxId: taxId + iban: iban + bankAccountNumber: bankAccountNumber + bankName: bankName + bankLocationId: bankLocationId + bic: bic + bankCity: bankCity + emailAddress: emailAddress + card: + cvc: cvc + number: number + holderName: holderName + startMonth: startMonth + issueNumber: issueNumber + expiryMonth: expiryMonth + startYear: startYear + expiryYear: expiryYear + brands: + - brands + - brands + configuration: + key: configuration + name: name + recurringDetailReference: recurringDetailReference details: - - configuration: '{}' + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key type: type items: - name: name @@ -5302,8 +6950,56 @@ components: id: id value: value key: key - - configuration: '{}' + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key type: type items: - name: name @@ -5312,10 +7008,57 @@ components: id: id value: value key: key - optional: true + itemSearchUrl: itemSearchUrl inputDetails: - - configuration: '{}' + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key type: type items: - name: name @@ -5324,8 +7067,56 @@ components: id: id value: value key: key - - configuration: '{}' + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key type: type items: - name: name @@ -5334,19 +7125,92 @@ components: id: id value: value key: key + itemSearchUrl: itemSearchUrl + fundingSource: debit type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' + brand: brand + group: + paymentMethodData: paymentMethodData + name: name + type: type + - storedDetails: + bank: + ownerName: ownerName + countryCode: countryCode + taxId: taxId + iban: iban + bankAccountNumber: bankAccountNumber + bankName: bankName + bankLocationId: bankLocationId + bic: bic + bankCity: bankCity + emailAddress: emailAddress + card: + cvc: cvc + number: number + holderName: holderName + startMonth: startMonth + issueNumber: issueNumber + expiryMonth: expiryMonth + startYear: startYear + expiryYear: expiryYear + brands: + - brands + - brands + configuration: + key: configuration + name: name + recurringDetailReference: recurringDetailReference details: - - configuration: '{}' + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key type: type items: - name: name @@ -5355,8 +7219,56 @@ components: id: id value: value key: key - - configuration: '{}' + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key type: type items: - name: name @@ -5365,20 +7277,57 @@ components: id: id value: value key: key - optional: true + itemSearchUrl: itemSearchUrl inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key type: type items: - name: name @@ -5387,624 +7336,354 @@ components: id: id value: value key: key + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + fundingSource: debit type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - refusalReason: refusalReason - additionalData: "" - merchantReference: merchantReference - pspReference: pspReference - authentication: '{}' - properties: - action: - $ref: '#/components/schemas/CheckoutPaymentsAction' - additionalData: - anyOf: - - $ref: '#/components/schemas/ResponseAdditionalDataCommon' - - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress' - - $ref: '#/components/schemas/ResponseAdditionalDataCard' - - $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress' - - $ref: '#/components/schemas/ResponseAdditionalDataInstallments' - - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens' - - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - - $ref: '#/components/schemas/ResponseAdditionalDataSepa' - description: This field contains additional data, which may be required - to return in a particular payment response. To choose data fields to be - returned, go to **Customer Area** > **Account** > **API URLs** > **Additional - data settings**. - amount: - $ref: '#/components/schemas/Amount' - authentication: - description: 'Contains `threeds2.fingerprint` or `threeds2.challengeToken` - values to be used in further calls to `/payments/details` endpoint. ' - type: object - details: - description: When non-empty, contains all the fields that you must submit - to the `/payments/details` endpoint. - items: - $ref: '#/components/schemas/InputDetail' - type: array - fraudResult: - $ref: '#/components/schemas/FraudResult' - merchantReference: - description: |- - The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. - If you need to provide multiple references for a transaction, separate them with hyphens ("-"). - Maximum length: 80 characters. - type: string - outputDetails: - description: Contains the details that will be presented to the shopper. - type: object - paymentData: - description: When non-empty, contains a value that you must submit to the - `/payments/details` endpoint. - type: string - pspReference: - description: |- - Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. - - > `pspReference` is returned only for non-redirect payment methods. - type: string - redirect: - $ref: '#/components/schemas/Redirect' - refusalReason: - description: |- - If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. - - When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. - type: string - refusalReasonCode: - description: Code that specifies the refusal reason. For more information, - see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). - type: string - resultCode: - description: |- - The result of the payment. Possible values: - - * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. - * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. - * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. - * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. - * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. - * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. - * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. For more information, refer to [Result codes](https://docs.adyen.com/checkout/payment-result-codes). - * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. - * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. - * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. - * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. - enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused - type: string - PaymentSetupRequest: - example: - dccQuote: - reference: reference - validTill: 2000-01-23T04:56:07.000+00:00 - signature: signature - accountType: accountType - buy: - currency: currency - value: 0 - sell: - currency: currency - value: 0 - interbank: - currency: currency - value: 0 - source: source - type: type - basePoints: 1 - account: account - baseAmount: - currency: currency - value: 0 - metadata: '{}' - sessionValidity: sessionValidity - splits: - - reference: reference - amount: - currency: currency - value: 2 - description: description - type: BalanceAccount - account: account - - reference: reference - amount: - currency: currency - value: 2 - description: description - type: BalanceAccount - account: account - channel: iOS - mcc: mcc - threeDSAuthenticationOnly: true - lineItems: - - quantity: 7 - amountExcludingTax: 5 - taxPercentage: 3 - description: description - id: id - amountIncludingTax: 2 - taxAmount: 9 - taxCategory: High - - quantity: 7 - amountExcludingTax: 5 - taxPercentage: 3 - description: description - id: id - amountIncludingTax: 2 - taxAmount: 9 - taxCategory: High - reference: reference - deliveryAddress: - country: country - stateOrProvince: stateOrProvince - city: city - houseNumberOrName: houseNumberOrName - street: street - postalCode: postalCode - installments: - value: 6 - additionalData: "" - blockedPaymentMethods: - - blockedPaymentMethods - - blockedPaymentMethods - trustedShopper: true - enablePayOut: true - fraudOffset: 5 - entityType: NaturalPerson - shopperEmail: shopperEmail - enableOneClick: true - orderReference: orderReference - sdkVersion: sdkVersion - shopperLocale: shopperLocale - captureDelayHours: 0 - applicationInfo: - adyenLibrary: - name: name - version: version - merchantApplication: - name: name - version: version - adyenPaymentSource: - name: name - version: version - merchantDevice: - reference: reference - os: os - osVersion: osVersion - shopperInteractionDevice: - os: os - osVersion: osVersion - locale: locale - externalPlatform: - name: name - integrator: integrator - version: version - shopperReference: shopperReference - shopperStatement: shopperStatement - recurringFrequency: recurringFrequency - telephoneNumber: telephoneNumber - configuration: - cardHolderName: NONE - installments: - value: 6 - shopperInput: - deliveryAddress: editable - personalDetails: editable - billingAddress: editable - avs: - addressEditable: true - enabled: "yes" - socialSecurityNumber: socialSecurityNumber - origin: origin - shopperIP: shopperIP - recurringExpiry: recurringExpiry - shopperName: - firstName: firstName - lastName: lastName - gender: MALE - infix: infix - enableRealTimeUpdate: true - countryCode: countryCode - shopperInteraction: Ecommerce - company: - registrationNumber: registrationNumber - registryLocation: registryLocation - taxId: taxId - name: name - type: type - homepage: homepage - deliveryDate: 2000-01-23T04:56:07.000+00:00 - returnUrl: returnUrl - conversionId: conversionId - merchantOrderReference: merchantOrderReference - amount: - currency: currency - value: 0 - dateOfBirth: 2000-01-23T04:56:07.000+00:00 - allowedPaymentMethods: - - allowedPaymentMethods - - allowedPaymentMethods - riskData: - clientData: clientData - token: token - storePaymentMethod: true - merchantAccount: merchantAccount - billingAddress: - country: country - stateOrProvince: stateOrProvince - city: city - houseNumberOrName: houseNumberOrName - street: street - postalCode: postalCode - enableRecurring: true + brand: brand + group: + paymentMethodData: paymentMethodData + name: name + type: type + paymentSession: paymentSession properties: - additionalData: - anyOf: - - $ref: '#/components/schemas/AdditionalDataCommon' - - $ref: '#/components/schemas/AdditionalData3DSecure' - - $ref: '#/components/schemas/AdditionalDataAirline' - - $ref: '#/components/schemas/AdditionalDataCarRental' - - $ref: '#/components/schemas/AdditionalDataLevel23' - - $ref: '#/components/schemas/AdditionalDataLodging' - - $ref: '#/components/schemas/AdditionalDataOpenInvoice' - - $ref: '#/components/schemas/AdditionalDataRatepay' - - $ref: '#/components/schemas/AdditionalDataRetry' - - $ref: '#/components/schemas/AdditionalDataRisk' - - $ref: '#/components/schemas/AdditionalDataRiskStandalone' - - $ref: '#/components/schemas/AdditionalDataTemporaryServices' - description: |- - This field contains additional data, which may be required for a particular payment request. - - The `additionalData` object consists of entries, each of which includes the key and value. - allowedPaymentMethods: - description: |- - List of payments methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). - - Example: `"allowedPaymentMethods":["ideal","giropay"]` - items: - type: string - type: array - amount: - $ref: '#/components/schemas/Amount' - applicationInfo: - $ref: '#/components/schemas/ApplicationInfo' - billingAddress: - $ref: '#/components/schemas/Address' - blockedPaymentMethods: - description: |- - List of payments methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). - - Example: `"blockedPaymentMethods":["ideal","giropay"]` - items: - type: string - type: array - captureDelayHours: - description: The delay between the authorisation and scheduled auto-capture, - specified in hours. - format: int32 - type: integer - channel: - description: |- - The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. - - Possible values: - * iOS - * Android - * Web - enum: - - iOS - - Android - - Web - type: string - company: - $ref: '#/components/schemas/Company' - configuration: - $ref: '#/components/schemas/Configuration' - conversionId: - description: Conversion ID that corresponds to the Id generated for tracking - user payment journey. - type: string - countryCode: - description: |- - The shopper country. - - Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - Example: NL or DE - type: string - dateOfBirth: - description: |- - The shopper's date of birth. - - Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD - format: date-time - type: string - dccQuote: - $ref: '#/components/schemas/ForexQuote' - deliveryAddress: - $ref: '#/components/schemas/Address' - deliveryDate: - description: |- - The date and time the purchased goods should be delivered. - - Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD - - Example: 2017-07-17T13:42:40.428+01:00 - format: date-time + paymentSession: + description: The encoded payment session that you need to pass to the SDK. type: string - enableOneClick: - description: When true and `shopperReference` is provided, the shopper will - be asked if the payment details should be stored for future one-click - payments. - type: boolean - enablePayOut: - description: When true and `shopperReference` is provided, the payment details - will be tokenized for payouts. - type: boolean - enableRealTimeUpdate: + recurringDetails: deprecated: true - description: Choose if a specific transaction should use the Real-time Account - Updater, regardless of other settings. - type: boolean - enableRecurring: - description: When true and `shopperReference` is provided, the payment details - will be tokenized for recurring payments. - type: boolean - entityType: - description: The type of the entity the payment is processed for. - enum: - - NaturalPerson - - CompanyName - type: string - fraudOffset: - description: An integer value that is added to the normal fraud score. The - value can be either positive or negative. - format: int32 - type: integer - installments: - $ref: '#/components/schemas/Installments' - lineItems: - description: |- - Price and product information about the purchased items, to be included on the invoice sent to the shopper. - > This field is required for Klarna, AfterPay, and RatePay. + description: The detailed list of stored payment details required to generate + payment forms. Will be empty if oneClick is set to false in the request. items: - $ref: '#/components/schemas/LineItem' + $ref: '#/components/schemas/RecurringDetail' type: array - mcc: - description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) - (MCC) is a four-digit number, which relates to a particular market segment. - This code reflects the predominant activity that is conducted by the merchant. - type: string - merchantAccount: - description: The merchant account identifier, with which you want to process - the transaction. + PaymentVerificationRequest: + example: + payload: payload + properties: + payload: + description: Encrypted and signed payment result data. You should receive + this value from the Checkout SDK after the shopper completes the payment. type: string - merchantOrderReference: - description: |- - This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. - The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. - > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + required: + - payload + PaymentVerificationResponse: + example: + refusalReasonCode: refusalReasonCode + serviceError: + errorType: errorType + errorCode: errorCode + message: message + resultCode: AuthenticationFinished + paymentMethod: paymentMethod + refusalReason: refusalReason + additionalData: "" + shopperLocale: shopperLocale + fraudResult: + accountScore: 0 + results: + - accountScore: 6 + name: name + checkId: 1 + - accountScore: 6 + name: name + checkId: 1 + merchantReference: merchantReference + pspReference: pspReference + order: + reference: reference + remainingAmount: + currency: currency + value: 5 + orderData: orderData + pspReference: pspReference + expiresAt: expiresAt + properties: + additionalData: + anyOf: + - $ref: '#/components/schemas/ResponseAdditionalDataCommon' + - $ref: '#/components/schemas/ResponseAdditionalData3DSecure' + - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress' + - $ref: '#/components/schemas/ResponseAdditionalDataCard' + - $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress' + - $ref: '#/components/schemas/ResponseAdditionalDataInstallments' + - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens' + - $ref: '#/components/schemas/ResponseAdditionalDataOpi' + - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' + - $ref: '#/components/schemas/ResponseAdditionalDataSepa' + description: This field contains additional data, which may be required + to return in a particular payment response. To choose data fields to be + returned, go to **Customer Area** > **Account** > **API URLs** > **Additional + data settings**. + fraudResult: + $ref: '#/components/schemas/FraudResult' + merchantReference: + description: A unique value that you provided in the initial `/paymentSession` + request as a `reference` field. type: string - metadata: - description: |- - Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". - type: object - orderReference: - description: When you are doing multiple partial (gift card) payments, this - is the `pspReference` of the first payment. We use this to link the multiple - payments to each other. As your own reference for linking multiple payments, - use the `merchantOrderReference`instead. + order: + $ref: '#/components/schemas/CheckoutOrderResponse' + paymentMethod: + description: The payment method used in the transaction. type: string - origin: + pspReference: description: |- - Required for the Web integration. + Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. - Set this parameter to the origin URL of the page that you are loading the SDK from. - type: string - recurringExpiry: - description: Date after which no further authorisations shall be performed. - Only for 3D Secure 2. - type: string - recurringFrequency: - description: Minimum number of days between authorisations. Only for 3D - Secure 2. - type: string - reference: - description: |- - The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. - If you need to provide multiple references for a transaction, separate them with hyphens ("-"). - Maximum length: 80 characters. - type: string - returnUrl: - description: |- - The URL to return to in case of a redirection. - The format depends on the channel. This URL can have a maximum of 1024 characters. - * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. - Example: `https://your-company.com/checkout?shopperOrder=12xy` - * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). - Example: `my-app://` - * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). - Example: `my-app://your.package.name` - type: string - riskData: - $ref: '#/components/schemas/RiskData' - sdkVersion: - description: The version of the SDK you are using (for Web SDK integrations - only). - type: string - sessionValidity: - description: The maximum validity of the session. + > `pspReference` is returned only for non-redirect payment methods. type: string - shopperEmail: + refusalReason: description: |- - The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. - > For 3D Secure 2 transactions, schemes require the `shopperEmail` for both `deviceChannel` **browser** and **app**. + If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + + For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string - shopperIP: - description: |- - The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). - > Required for 3D Secure 2 transactions. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new). + refusalReasonCode: + description: Code that specifies the refusal reason. For more information, + see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). type: string - shopperInteraction: + resultCode: description: |- - Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. - For the web service API, Adyen assumes Ecommerce shopper interaction by default. + The result of the payment. For more information, see [Result codes](https://docs.adyen.com/checkout/payment-result-codes). - This field has the following possible values: - * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. - * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). - * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. - * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + Possible values: + + * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. + * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). + * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. + * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. + * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. + * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. + * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. + * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. + * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. + * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. + * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. + * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. enum: - - Ecommerce - - ContAuth - - Moto - - POS + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused type: string + serviceError: + $ref: '#/components/schemas/ServiceError' shopperLocale: - description: The combination of a language code and a country code to specify - the language to be used in the payment. + description: The shopperLocale value provided in the payment request. type: string - shopperName: - $ref: '#/components/schemas/Name' - shopperReference: + required: + - merchantReference + - paymentMethod + - shopperLocale + QiwiWalletDetails: + properties: + telephoneNumber: + type: string + type: + default: qiwiwallet + description: '**qiwiwallet**' + type: string + required: + - telephoneNumber + - type + Recurring: + example: + recurringExpiry: 2000-01-23T04:56:07.000+00:00 + recurringFrequency: recurringFrequency + tokenService: VISATOKENSERVICE + contract: ONECLICK + recurringDetailName: recurringDetailName + properties: + contract: description: |- - The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). - > This field is required for recurring payments. + The type of recurring contract to be used. + Possible values: + * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). + * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). + * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. + * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/checkout/online-payouts). + enum: + - ONECLICK + - RECURRING + - PAYOUT type: string - shopperStatement: - description: The text to appear on the shopper's bank statement. + recurringDetailName: + description: A descriptive name for this detail. type: string - socialSecurityNumber: - description: The shopper's social security number. + recurringExpiry: + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + format: date-time type: string - splits: - description: Information on how the payment should be split between accounts - when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). - items: - $ref: '#/components/schemas/Split' - type: array - storePaymentMethod: - description: When true and `shopperReference` is provided, the payment details - will be stored. - type: boolean - telephoneNumber: - description: The shopper's telephone number. + recurringFrequency: + description: Minimum number of days between authorisations. Only for 3D + Secure 2. type: string - threeDSAuthenticationOnly: - description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), - and not the payment authorisation. - type: boolean - token: - description: |- - The token obtained when initializing the SDK. - - > This parameter is required for iOS and Android; not required for Web. + tokenService: + description: The name of the token service. + enum: + - VISATOKENSERVICE + - MCTOKENSERVICE type: string - trustedShopper: - description: Set to true if the payment should be routed to a trusted MID. - type: boolean - required: - - amount - - countryCode - - merchantAccount - - reference - - returnUrl - PaymentSetupResponse: + RecurringDetail: example: - recurringDetails: - - storedDetails: - bank: - ownerName: ownerName - countryCode: countryCode - taxId: taxId - iban: iban - bankAccountNumber: bankAccountNumber - bankName: bankName - bankLocationId: bankLocationId - bic: bic - bankCity: bankCity - emailAddress: emailAddress - card: - cvc: cvc - number: number - holderName: holderName - startMonth: startMonth - issueNumber: issueNumber - expiryMonth: expiryMonth - startYear: startYear - expiryYear: expiryYear - supportsRecurring: true - brands: - - brands - - brands - configuration: '{}' - paymentMethodData: paymentMethodData - name: name - recurringDetailReference: recurringDetailReference + storedDetails: + bank: + ownerName: ownerName + countryCode: countryCode + taxId: taxId + iban: iban + bankAccountNumber: bankAccountNumber + bankName: bankName + bankLocationId: bankLocationId + bic: bic + bankCity: bankCity + emailAddress: emailAddress + card: + cvc: cvc + number: number + holderName: holderName + startMonth: startMonth + issueNumber: issueNumber + expiryMonth: expiryMonth + startYear: startYear + expiryYear: expiryYear + brands: + - brands + - brands + configuration: + key: configuration + name: name + recurringDetailReference: recurringDetailReference + details: + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration details: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -6013,51 +7692,9 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -6066,52 +7703,11 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl + optional: true inputDetails: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -6120,51 +7716,9 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -6173,86 +7727,80 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl type: type - group: - paymentMethodData: paymentMethodData - name: name + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + inputDetails: + - configuration: + key: configuration + details: + - configuration: + key: configuration + optional: true type: type - - storedDetails: - bank: - ownerName: ownerName - countryCode: countryCode - taxId: taxId - iban: iban - bankAccountNumber: bankAccountNumber - bankName: bankName - bankLocationId: bankLocationId - bic: bic - bankCity: bankCity - emailAddress: emailAddress - card: - cvc: cvc - number: number - holderName: holderName - startMonth: startMonth - issueNumber: issueNumber - expiryMonth: expiryMonth - startYear: startYear - expiryYear: expiryYear - supportsRecurring: true - brands: - - brands - - brands - configuration: '{}' - paymentMethodData: paymentMethodData - name: name - recurringDetailReference: recurringDetailReference + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + optional: true + inputDetails: + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + - configuration: + key: configuration + optional: true + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + type: type + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + - configuration: + key: configuration details: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -6261,51 +7809,9 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -6314,52 +7820,11 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl + optional: true inputDetails: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -6368,51 +7833,9 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key + - configuration: + key: configuration optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key type: type items: - name: name @@ -6421,490 +7844,647 @@ components: id: id value: value key: key - itemSearchUrl: itemSearchUrl type: type - group: - paymentMethodData: paymentMethodData - name: name - type: type - paymentSession: paymentSession + items: + - name: name + id: id + - name: name + id: id + value: value + key: key + itemSearchUrl: itemSearchUrl + fundingSource: debit + type: type + brand: brand + group: + paymentMethodData: paymentMethodData + name: name + type: type + properties: + brand: + description: 'Brand for the selected gift card. For example: plastix, hmclub.' + type: string + brands: + description: 'List of possible brands. For example: visa, mc.' + items: + type: string + type: array + configuration: + additionalProperties: + type: string + description: The configuration of the payment method. + type: object + details: + description: All input details to be provided to complete the payment with + this payment method. + items: + $ref: '#/components/schemas/InputDetail' + type: array + fundingSource: + description: The funding source of the payment method. + enum: + - debit + type: string + group: + $ref: '#/components/schemas/PaymentMethodGroup' + inputDetails: + deprecated: true + description: All input details to be provided to complete the payment with + this payment method. + items: + $ref: '#/components/schemas/InputDetail' + type: array + name: + description: The displayable name of this payment method. + type: string + recurringDetailReference: + description: The reference that uniquely identifies the recurring detail. + type: string + storedDetails: + $ref: '#/components/schemas/StoredDetails' + type: + description: The unique payment method code. + type: string + Redirect: + example: + data: + key: data + method: GET + url: url + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: |- + The web method that you must use to access the redirect URL. + + Possible values: GET, POST. + enum: + - GET + - POST + type: string + url: + description: The URL, to which you must redirect a shopper to complete a + payment. + type: string + ResponseAdditionalData3DSecure: properties: - paymentSession: - description: The encoded payment session that you need to pass to the SDK. + scaExemptionRequested: + description: "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ + \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ + \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " + type: string + ResponseAdditionalDataBillingAddress: + properties: + billingAddress.city: + description: The billing address city passed in the payment request. + type: string + billingAddress.country: + description: |- + The billing address country passed in the payment request. + + Example: NL + type: string + billingAddress.houseNumberOrName: + description: The billing address house number or name passed in the payment + request. + type: string + billingAddress.postalCode: + description: |- + The billing address postal code passed in the payment request. + + Example: 1011 DJ + type: string + billingAddress.stateOrProvince: + description: |- + The billing address state or province passed in the payment request. + + Example: NH + type: string + billingAddress.street: + description: The billing address street passed in the payment request. + type: string + ResponseAdditionalDataCard: + properties: + cardBin: + description: |- + The Bank Identification Number of a credit card, which is the first six digits of a card number. + + Example: 521234 + type: string + cardHolderName: + description: The cardholder name passed in the payment request. + type: string + cardIssuingBank: + description: The bank or the financial institution granting lines of credit + through card association branded payment cards. This information can be + included when available. + type: string + cardIssuingCountry: + description: |- + The country where the card was issued. + + Example: US + type: string + cardIssuingCurrency: + description: "The currency in which the card is issued, if this information\ + \ is available. Provided as the currency code or currency number from\ + \ the ISO-4217 standard. \n\nExample: USD" + type: string + cardPaymentMethod: + description: |- + The card payment method used for the transaction. + + Example: amex + type: string + cardSummary: + description: |- + The last four digits of a card number. + + > Returned only in case of a card payment. + type: string + ResponseAdditionalDataCommon: + properties: + acquirerAccountCode: + description: |- + The name of the Adyen acquirer account. + + Example: PayPalSandbox_TestAcquirer + + > Only relevant for PayPal transactions. + type: string + acquirerCode: + description: |- + The name of the acquirer processing the payment request. + + Example: TestPmmAcquirer + type: string + acquirerReference: + description: |- + The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. + + Example: 7C9N3FNBKT9 + type: string + alias: + description: |- + The Adyen alias of the card. + + Example: H167852639363479 + type: string + aliasType: + description: |- + The type of the card alias. + + Example: Default + type: string + authCode: + description: |- + Authorisation code: + * When the payment is authorised successfully, this field holds the authorisation code for the payment. + * When the payment is not authorised, this field is empty. + + Example: 58747 + type: string + authorisedAmountCurrency: + description: The currency of the authorised amount, as a three-character + [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + type: string + authorisedAmountValue: + description: |- + Value of the amount authorised. + + This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + type: string + avsResult: + description: |- + The AVS result code of the payment, which provides information about the outcome of the AVS check. + + For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs). + type: string + avsResultRaw: + description: |- + Raw AVS result received from the acquirer, where available. + + Example: D + type: string + bic: + description: |- + BIC of a bank account. + + Example: TESTNL01 + + > Only relevant for SEPA Direct Debit transactions. + type: string + dsTransID: + description: Supported for 3D Secure 2. The unique transaction identifier + assigned by the DS to identify a single transaction. + type: string + eci: + description: |- + The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. + + Example: 02 + type: string + expiryDate: + description: |- + The expiry date on the card. + + Example: 6/2016 + + > Returned only in case of a card payment. + type: string + extraCostsCurrency: + description: |- + The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. + + Example: EUR + type: string + extraCostsValue: + description: The value of the extra amount charged due to additional amounts + set in the skin used in the HPP payment request. The amount is in minor + units. + type: string + fraudCheck-[itemNr]-[FraudCheckname]: + description: The fraud score due to a particular fraud check. The fraud + check name is found in the key of the key-value pair. + type: string + fundingSource: + description: |- + Information regarding the funding type of the card. The possible return values are: + * CHARGE + * CREDIT + * DEBIT + * PREPAID + * PREPAID_RELOADABLE + + * PREPAID_NONRELOADABLE + * DEFFERED_DEBIT + + > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. + + For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. + type: string + fundsAvailability: + description: |- + Indicates availability of funds. + + Visa: + * "I" (fast funds are supported) + * "N" (otherwise) + + Mastercard: + * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) + * "N" (otherwise) + + > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is "Y" or "D". + type: string + inferredRefusalReason: + description: |- + Provides the more granular indication of why a transaction was refused. When a transaction fails with either "Refused", "Restricted Card", "Transaction Not Permitted", "Not supported" or "DeclinedNon Generic" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to "Not Supported". + + Possible values: + + * 3D Secure Mandated + * Closed Account + * ContAuth Not Supported + * CVC Mandated + * Ecommerce Not Allowed + * Crossborder Not Supported + * Card Updated + + * Low Authrate Bin + * Non-reloadable prepaid card + type: string + issuerCountry: + description: |- + The issuing country of the card based on the BIN list that Adyen maintains. + + Example: JP + type: string + mcBankNetReferenceNumber: + description: |- + The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. + + > Contact Support Team to enable this field. + type: string + networkTxReference: + description: |- + Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. + + This contains either the Mastercard Trace ID or the Visa Transaction ID. + type: string + ownerName: + description: |- + The owner name of a bank account. + + Only relevant for SEPA Direct Debit transactions. type: string - recurringDetails: - deprecated: true - description: The detailed list of stored payment details required to generate - payment forms. Will be empty if oneClick is set to false in the request. - items: - $ref: '#/components/schemas/RecurringDetail' - type: array - PaymentVerificationRequest: - example: - payload: payload - properties: - payload: - description: Encrypted and signed payment result data. You should receive - this value from the Checkout SDK after the shopper completes the payment. + paymentAccountReference: + description: The Payment Account Reference (PAR) value links a network token + with the underlying primary account number (PAN). The PAR value consists + of 29 uppercase alphanumeric characters. type: string - required: - - payload - PaymentVerificationResponse: - example: - refusalReasonCode: refusalReasonCode - serviceError: - errorType: errorType - errorCode: errorCode - message: message - resultCode: AuthenticationFinished - paymentMethod: paymentMethod - refusalReason: refusalReason - additionalData: "" - shopperLocale: shopperLocale - fraudResult: - accountScore: 0 - results: - - accountScore: 6 - name: name - checkId: 1 - - accountScore: 6 - name: name - checkId: 1 - merchantReference: merchantReference - pspReference: pspReference - properties: - additionalData: - anyOf: - - $ref: '#/components/schemas/ResponseAdditionalDataCommon' - - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress' - - $ref: '#/components/schemas/ResponseAdditionalDataCard' - - $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress' - - $ref: '#/components/schemas/ResponseAdditionalDataInstallments' - - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens' - - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - - $ref: '#/components/schemas/ResponseAdditionalDataSepa' - description: This field contains additional data, which may be required - to return in a particular payment response. To choose data fields to be - returned, go to **Customer Area** > **Account** > **API URLs** > **Additional - data settings**. - fraudResult: - $ref: '#/components/schemas/FraudResult' - merchantReference: - description: A unique value that you provided in the initial `/paymentSession` - request as a `reference` field. + paymentMethodVariant: + description: |- + The Adyen sub-variant of the payment method used for the payment request. + + For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). + + Example: mcpro type: string - paymentMethod: - description: The payment method used in the transaction. + payoutEligible: + description: |- + Indicates whether a payout is eligible or not for this card. + + Visa: + * "Y" + * "N" + + Mastercard: + * "Y" (domestic and cross-border) + + * "D" (only domestic) + * "N" (no MoneySend) + * "U" (unknown) type: string - pspReference: + realtimeAccountUpdaterStatus: description: |- - Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + The response code from the Real Time Account Updater service. - > `pspReference` is returned only for non-redirect payment methods. + Possible return values are: + * CardChanged + * CardExpiryChanged + * CloseAccount + + * ContactCardAccountHolder type: string - refusalReason: + receiptFreeText: + description: Message to be displayed on the terminal. + type: string + recurring.firstPspReference: description: |- - If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. + The `pspReference`, of the first recurring payment that created the recurring detail. - When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. type: string - refusalReasonCode: - description: Code that specifies the refusal reason. For more information, - see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + recurring.recurringDetailReference: + description: The reference that uniquely identifies the recurring transaction. type: string - resultCode: + referred: description: |- - The result of the payment. Possible values: + If the payment is referred, this field is set to true. - * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. - * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. - * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. - * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. - * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. - * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. - * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. For more information, refer to [Result codes](https://docs.adyen.com/checkout/payment-result-codes). - * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. - * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. - * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. - * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. - enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused + This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. + + Example: true type: string - serviceError: - $ref: '#/components/schemas/ServiceError' - shopperLocale: - description: The shopperLocale value provided in the payment request. + refusalReasonRaw: + description: |- + Raw refusal reason received from the acquirer, where available. + + Example: AUTHORISED type: string - required: - - merchantReference - - paymentMethod - - shopperLocale - Recurring: + shopperInteraction: + description: |- + The shopper interaction type of the payment request. + + Example: Ecommerce + type: string + shopperReference: + description: |- + The shopperReference passed in the payment request. + + Example: AdyenTestShopperXX + type: string + terminalId: + description: |- + The terminal ID used in a point-of-sale payment. + + Example: 06022622 + type: string + threeDAuthenticated: + description: |- + A Boolean value indicating whether 3DS authentication was completed on this payment. + + Example: true + type: string + threeDAuthenticatedResponse: + description: |- + The raw 3DS authentication result from the card issuer. + + Example: N + type: string + threeDOffered: + description: |- + A Boolean value indicating whether 3DS was offered for this payment. + + Example: true + type: string + threeDOfferedResponse: + description: |- + The raw enrollment result from the 3DS directory services of the card schemes. + + Example: Y + type: string + threeDSVersion: + description: The 3D Secure 2 version. + type: string + visaTransactionId: + description: |- + The `visaTransactionId`, has a fixed length of 15 numeric characters. + + > Contact Support Team to enable this field. + type: string + xid: + description: |- + The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. + + Example: ODgxNDc2MDg2MDExODk5MAAAAAA= + type: string + ResponseAdditionalDataDeliveryAddress: properties: - contract: + deliveryAddress.city: + description: The delivery address city passed in the payment request. + type: string + deliveryAddress.country: description: |- - The type of recurring contract to be used. - Possible values: - * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). - * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). - * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. - * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/checkout/online-payouts). - enum: - - ONECLICK - - RECURRING - - PAYOUT + The delivery address country passed in the payment request. + + Example: NL + type: string + deliveryAddress.houseNumberOrName: + description: The delivery address house number or name passed in the payment + request. + type: string + deliveryAddress.postalCode: + description: |- + The delivery address postal code passed in the payment request. + + Example: 1011 DJ + type: string + deliveryAddress.stateOrProvince: + description: |- + The delivery address state or province passed in the payment request. + + Example: NH + type: string + deliveryAddress.street: + description: The delivery address street passed in the payment request. + type: string + ResponseAdditionalDataInstallments: + properties: + installmentPaymentData.installmentType: + description: Type of installment. The value of `installmentType` should + be **IssuerFinanced**. type: string - recurringDetailName: - description: A descriptive name for this detail. + installmentPaymentData.option[itemNr].annualPercentageRate: + description: Annual interest rate. type: string - recurringExpiry: - description: Date after which no further authorisations shall be performed. - Only for 3D Secure 2. - format: date-time + installmentPaymentData.option[itemNr].firstInstallmentAmount: + description: First Installment Amount in minor units. type: string - recurringFrequency: - description: Minimum number of days between authorisations. Only for 3D - Secure 2. + installmentPaymentData.option[itemNr].installmentFee: + description: Installment fee amount in minor units. type: string - tokenService: - description: The name of the token service. - enum: - - VISATOKENSERVICE - - MCTOKENSERVICE + installmentPaymentData.option[itemNr].interestRate: + description: Interest rate for the installment period. type: string - RecurringDetail: - example: - storedDetails: - bank: - ownerName: ownerName - countryCode: countryCode - taxId: taxId - iban: iban - bankAccountNumber: bankAccountNumber - bankName: bankName - bankLocationId: bankLocationId - bic: bic - bankCity: bankCity - emailAddress: emailAddress - card: - cvc: cvc - number: number - holderName: holderName - startMonth: startMonth - issueNumber: issueNumber - expiryMonth: expiryMonth - startYear: startYear - expiryYear: expiryYear - supportsRecurring: true - brands: - - brands - - brands - configuration: '{}' - paymentMethodData: paymentMethodData - name: name - recurringDetailReference: recurringDetailReference - details: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - inputDetails: - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - - configuration: '{}' - details: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - optional: true - inputDetails: - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - - configuration: '{}' - optional: true - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - type: type - items: - - name: name - id: id - - name: name - id: id - value: value - key: key - itemSearchUrl: itemSearchUrl - type: type - group: - paymentMethodData: paymentMethodData - name: name - type: type + installmentPaymentData.option[itemNr].maximumNumberOfInstallments: + description: Maximum number of installments possible for this payment. + type: string + installmentPaymentData.option[itemNr].minimumNumberOfInstallments: + description: Minimum number of installments possible for this payment. + type: string + installmentPaymentData.option[itemNr].numberOfInstallments: + description: Total number of installments possible for this payment. + type: string + installmentPaymentData.option[itemNr].subsequentInstallmentAmount: + description: Subsequent Installment Amount in minor units. + type: string + installmentPaymentData.option[itemNr].totalAmountDue: + description: Total amount in minor units. + type: string + installmentPaymentData.paymentOptions: + description: |- + Possible values: + * PayInInstallmentsOnly + * PayInFullOnly + * PayInFullOrInstallments + type: string + installments.value: + description: |- + The number of installments that the payment amount should be charged with. + + Example: 5 + > Only relevant for card payments in countries that support installments. + type: string + ResponseAdditionalDataNetworkTokens: properties: - brands: - description: 'List of possible brands. For example: visa, mc.' - items: - type: string - type: array - configuration: - description: The configuration of the payment method. - type: object - details: - description: All input details to be provided to complete the payment with - this payment method. - items: - $ref: '#/components/schemas/InputDetail' - type: array - group: - $ref: '#/components/schemas/PaymentMethodGroup' - inputDetails: - deprecated: true - description: All input details to be provided to complete the payment with - this payment method. - items: - $ref: '#/components/schemas/InputDetail' - type: array - name: - description: The displayable name of this payment method. + networkToken.available: + description: Indicates whether a network token is available for the specified + card. type: string - paymentMethodData: - description: Echo data required to send in next calls. + networkToken.bin: + description: The Bank Identification Number of a tokenized card, which is + the first six digits of a card number. type: string - recurringDetailReference: - description: The reference that uniquely identifies the recurring detail. + networkToken.tokenSummary: + description: The last four digits of a network token. type: string - storedDetails: - $ref: '#/components/schemas/StoredDetails' - supportsRecurring: - description: Indicates whether this payment method supports tokenization - or not. - type: boolean - type: - description: The unique payment method code. + ResponseAdditionalDataOpi: + properties: + opi.transToken: + description: 'Returned in the response if you included `opi.includeTransToken: + true` in an ecommerce payment request. This contains an Oracle Payment + Interface token that you can store in your Oracle Opera database to identify + tokenized ecommerce transactions. For more information and required settings, + see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string - Redirect: - example: - data: '{}' - method: GET - url: url + ResponseAdditionalDataPayPal: properties: - data: - description: When the redirect URL must be accessed via POST, use this data - to post to the redirect URL. - type: object - method: + paypalEmail: description: |- - The web method that you must use to access the redirect URL. + The buyer's PayPal account email address. - Possible values: GET, POST. - enum: - - GET - - POST + Example: paypaltest@adyen.com type: string - url: - description: The URL, to which you must redirect a shopper to complete a - payment. + paypalPayerId: + description: |- + The buyer's PayPal ID. + + Example: LF5HCWWBRV2KL + type: string + paypalPayerResidenceCountry: + description: |- + The buyer's country of residence. + + Example: NL + type: string + paypalPayerStatus: + description: |- + The status of the buyer's PayPal account. + + Example: unverified + type: string + paypalProtectionEligibility: + description: |- + The eligibility for PayPal Seller Protection for this payment. + + Example: Ineligible + type: string + ResponseAdditionalDataSepa: + properties: + sepadirectdebit.dateOfSignature: + description: |- + The transaction signature date. + + Format: yyyy-MM-dd + type: string + sepadirectdebit.mandateId: + description: Its value corresponds to the pspReference value of the transaction. + type: string + sepadirectdebit.sequenceType: + description: |- + This field can take one of the following values: + * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. + + * First: (FRST) Initial/first collection in a series of direct debit instructions. + * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. + * Final: (FNAL) Last/final collection in a series of direct debit instructions. + + Example: OOFF type: string RiskData: example: + fraudOffset: 2 + customFields: + key: customFields + profileReference: profileReference clientData: clientData properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + customFields: + additionalProperties: + type: string + description: Any custom fields used as part of the input to configured risk + rules. + type: object + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + profileReference: + description: The risk profile to assign to this payment. When left empty, + the merchant-level account's default risk profile will be applied. + type: string SDKEphemPubKey: example: kty: kty @@ -6924,6 +8504,62 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + SamsungPayDetails: + properties: + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + samsungPayToken: + type: string + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: samsungpay + description: '**samsungpay**' + type: string + required: + - samsungPayToken + - type + SepaDirectDebitDetails: + properties: + iban: + description: The International Bank Account Number (IBAN). + type: string + ownerName: + description: The name of the bank account holder. + type: string + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: sepadirectdebit + description: '**sepadirectdebit**' + type: string + required: + - iban + - ownerName + - type ServiceError: example: errorType: errorType @@ -7002,7 +8638,7 @@ components: reference: reference amount: currency: currency - value: 2 + value: 7 description: description type: BalanceAccount account: account @@ -7044,7 +8680,7 @@ components: SplitAmount: example: currency: currency - value: 2 + value: 7 properties: currency: description: |- @@ -7141,9 +8777,28 @@ components: type: description: The type of payment method. type: string + StoredPaymentMethodDetails: + properties: + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + description: The payment method type. + type: string + required: + - type SubInputDetail: example: - configuration: '{}' + configuration: + key: configuration optional: true type: type items: @@ -7155,6 +8810,8 @@ components: key: key properties: configuration: + additionalProperties: + type: string description: Configuration parameters for the required input. type: object items: @@ -7174,12 +8831,74 @@ components: value: description: The value can be pre-filled, if available. type: string + SubscriptionDetails: + properties: + amount: + description: The billing amount of the recurring transactions. + type: string + amountRule: + description: |- + The limitation rule of the billing amount. + + Possible values: + * `max`: The transaction amount can not exceed the `amount`. + * `exact`: The transaction amount should be the same as the `amount`. + enum: + - max + - exact + type: string + billingAttemptsRule: + description: |- + The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. + + Possible values: + * `on`: On a specific date. * `before`: Before and on a specific date. * `after`: On and after a specific date. + enum: + - "on" + - before + - after + type: string + billingDay: + description: |- + The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. + + Possible values: 1-31 based on the `frequency`. + type: string + endAt: + description: End date of the billing plan, in YYYY-MM-DD format. + type: string + frequency: + description: |- + The frequency with which a shopper should be charged. + + Possible values: daily, weekly, biWeekly, monthly, quarterly, halfYearly, yearly. + enum: + - adhoc + - daily + - weekly + - biWeekly + - monthly + - quarterly + - halfYearly + - yearly + type: string + remarks: + description: The message shown by UPI to the shopper on the approval screen. + type: string + startAt: + description: Start date of the billing plan, in YYYY-MM-DD format. By default, + the transaction date. + type: string + required: + - amount + - endAt + - frequency ThreeDS2RequestData: example: notificationURL: notificationURL whiteListStatus: whiteListStatus - authenticationOnly: true - sdkMaxTimeout: 7 + authenticationOnly: false + sdkMaxTimeout: 1 sdkEncData: sdkEncData acquirerBIN: acquirerBIN mcc: mcc @@ -7189,7 +8908,7 @@ components: sdkUiType: - multiSelect - multiSelect - sdkInterface: Html + sdkInterface: both sdkEphemPubKey: kty: kty crv: crv @@ -7203,7 +8922,7 @@ components: threeDSRequestorName: threeDSRequestorName acquirerMerchantID: acquirerMerchantID sdkAppID: sdkAppID - messageVersion: messageVersion + messageVersion: 2.1.0 threeDSCompInd: threeDSCompInd sdkTransID: sdkTransID properties: @@ -7219,9 +8938,13 @@ components: Use 123456 on the Test platform. type: string authenticationOnly: + default: false + deprecated: true description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean + x-deprecatedInVersion: 50 + x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. challengeIndicator: description: | Possibility to specify a preference for receiving a challenge from the issuer. @@ -7257,6 +8980,7 @@ components: > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/checkout/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account. type: string messageVersion: + default: 2.1.0 description: The `messageVersion` value indicating the 3D Secure 2 protocol version. type: string @@ -7359,8 +9083,6 @@ components: description: |- In 3D Secure 1, this is the enrollment response from the 3D directory server. - - In 3D Secure 2, this is the `transStatus` from the `ARes`. enum: - A @@ -7387,6 +9109,122 @@ components: 20 bytes in a decoded form). format: byte type: string + UpdatePaymentLinkRequest: + example: + status: expired + properties: + status: + description: |- + Status of the payment link. Possible values: + * **expired** + enum: + - expired + type: string + required: + - status + UpiDetails: + properties: + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used for recurring payment only. + type: string + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + subscriptionDetails: + $ref: '#/components/schemas/SubscriptionDetails' + type: + default: upi + description: '**upi**' + type: string + virtualPaymentAddress: + description: The virtual payment address for UPI. + type: string + required: + - type + VippsDetails: + properties: + recurringDetailReference: + deprecated: true + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + x-deprecatedInVersion: 49 + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + telephoneNumber: + type: string + type: + default: vipps + description: '**vipps**' + type: string + required: + - telephoneNumber + - type + VisaCheckoutDetails: + properties: + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + type: + default: visacheckout + description: '**visacheckout**' + type: string + visaCheckoutCallId: + type: string + required: + - type + - visaCheckoutCallId + WeChatPayDetails: + properties: + appId: + type: string + openid: + type: string + type: + default: wechatpay + description: '**wechatpay**' + type: string + required: + - type + WeChatPayMiniProgramDetails: + properties: + appId: + type: string + openid: + type: string + type: + default: wechatpayMiniProgram + description: '**wechatpayMiniProgram**' + type: string + required: + - type + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http x-groups: -- API Integration -- SDK Integration +- Payments +- Payment links +- Orders +- Classic Checkout SDK +- Utility diff --git a/src/checkout/api_default.go b/src/checkout/api_default.go index a0cc7c7cc..d90344957 100644 --- a/src/checkout/api_default.go +++ b/src/checkout/api_default.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,27 +14,93 @@ import ( _context "context" _nethttp "net/http" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // Checkout Checkout service type Checkout common.Service /* -PaymentLinks Creates a payment link. +GetPaymentLink Retrieve a payment link. +Retrieves the payment link details using the payment link `id`. + * @param linkId Unique identifier of the payment link. + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return PaymentLinkResource +*/ +func (a Checkout) GetPaymentLink(linkId string, ctxs ..._context.Context) (PaymentLinkResource, *_nethttp.Response, error) { + res := &PaymentLinkResource{} + httpRes, err := a.Client.MakeHTTPGetRequest(res, a.BasePath()+"/paymentLinks/"+linkId, ctxs...) + return *res, httpRes, err +} + +/* +UpdatePaymentLink Update the status of a payment link +Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/checkout/pay-by-link#update-payment-link-status). + * @param linkId Unique identifier of the payment link. + * @param request UpdatePaymentLinkRequest - reference of UpdatePaymentLinkRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return PaymentLinkResource +*/ +func (a Checkout) UpdatePaymentLink(linkId string, req *UpdatePaymentLinkRequest, ctxs ..._context.Context) (PaymentLinkResource, *_nethttp.Response, error) { + res := &PaymentLinkResource{} + httpRes, err := a.Client.MakeHTTPPatchRequest(req, res, a.BasePath()+"/paymentLinks/"+linkId, ctxs...) + return *res, httpRes, err +} + +/* +PostOrders Creates an order for the given amount. +Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods. + * @param request CheckoutCreateOrderRequest - reference of CheckoutCreateOrderRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return CheckoutCreateOrderResponse +*/ +func (a Checkout) Orders(req *CheckoutCreateOrderRequest, ctxs ..._context.Context) (CheckoutCreateOrderResponse, *_nethttp.Response, error) { + res := &CheckoutCreateOrderResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/orders", ctxs...) + return *res, httpRes, err +} + +/* +PostOrdersCancel Cancels the given order. +Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method. + * @param request CheckoutCancelOrderRequest - reference of CheckoutCancelOrderRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return CheckoutCancelOrderResponse +*/ +func (a Checkout) OrdersCancel(req *CheckoutCancelOrderRequest, ctxs ..._context.Context) (CheckoutCancelOrderResponse, *_nethttp.Response, error) { + res := &CheckoutCancelOrderResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/orders/cancel", ctxs...) + return *res, httpRes, err +} + +/* +PostOriginKeys Create originKey values for one or more merchant domains. +This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > Instead of using an origin key, consider [switching to a client key](https://docs.adyen.com/user-management/client-side-authentication/migrate-from-origin-key-to-client-key) for your Web Drop-in or Web Component integration. This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. + * @param request CheckoutUtilityRequest - reference of CheckoutUtilityRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return CheckoutUtilityResponse +*/ +func (a Checkout) OriginKeys(req *CheckoutUtilityRequest, ctxs ..._context.Context) (CheckoutUtilityResponse, *_nethttp.Response, error) { + res := &CheckoutUtilityResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/originKeys", ctxs...) + return *res, httpRes, err +} + +/* +PostPaymentLinks Creates a payment link. Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/checkout/pay-by-link#create-payment-links-through-api). * @param request CreatePaymentLinkRequest - reference of CreatePaymentLinkRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return CreatePaymentLinkResponse +@return PaymentLinkResource */ -func (a Checkout) PaymentLinks(req *CreatePaymentLinkRequest, ctxs ..._context.Context) (CreatePaymentLinkResponse, *_nethttp.Response, error) { - res := &CreatePaymentLinkResponse{} +func (a Checkout) PaymentLinks(req *CreatePaymentLinkRequest, ctxs ..._context.Context) (PaymentLinkResource, *_nethttp.Response, error) { + res := &PaymentLinkResource{} httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/paymentLinks", ctxs...) return *res, httpRes, err } /* -PaymentMethods Returns available payment methods. +PostPaymentMethods Returns available payment methods. Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week. * @param request PaymentMethodsRequest - reference of PaymentMethodsRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -47,34 +113,34 @@ func (a Checkout) PaymentMethods(req *PaymentMethodsRequest, ctxs ..._context.Co } /* -PaymentSession Creates a payment session. -Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/checkout#howitworks). - * @param request PaymentSetupRequest - reference of PaymentSetupRequest). +PostPaymentMethodsBalance Returns the available balance on gift card. +Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object. + * @param request CheckoutBalanceCheckRequest - reference of CheckoutBalanceCheckRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return PaymentSetupResponse +@return CheckoutBalanceCheckResponse */ -func (a Checkout) PaymentSession(req *PaymentSetupRequest, ctxs ..._context.Context) (PaymentSetupResponse, *_nethttp.Response, error) { - res := &PaymentSetupResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/paymentSession", ctxs...) +func (a Checkout) PaymentMethodsBalance(req *CheckoutBalanceCheckRequest, ctxs ..._context.Context) (CheckoutBalanceCheckResponse, *_nethttp.Response, error) { + res := &CheckoutBalanceCheckResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/paymentMethods/balance", ctxs...) return *res, httpRes, err } /* -PaymentsDetails Submits details for a payment. -Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request (for example for 3D Secure, or when getting redirected back directly from a payment method using an app switch). The exact details, which need to be sent to this endpoint, are always specified in the response of the associated `/payments` request. In addition, the endpoint can be used to verify a `payload`, which is returned after coming back from the Checkout SDK or any of the redirect based methods on the Checkout API. - * @param request DetailsRequest - reference of DetailsRequest). +PostPaymentSession Creates a payment session. +Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/checkout#howitworks). + * @param request PaymentSetupRequest - reference of PaymentSetupRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return PaymentResponse +@return PaymentSetupResponse */ -func (a Checkout) PaymentsDetails(req *DetailsRequest, ctxs ..._context.Context) (PaymentResponse, *_nethttp.Response, error) { - res := &PaymentResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/payments/details", ctxs...) +func (a Checkout) PaymentSession(req *PaymentSetupRequest, ctxs ..._context.Context) (PaymentSetupResponse, *_nethttp.Response, error) { + res := &PaymentSetupResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/paymentSession", ctxs...) return *res, httpRes, err } /* -Payments Starts a transaction. -Sends payment parameters (like amount, country, and currency) together with the input details collected from the shopper. The response returns the result of the payment request: * For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. `Authorised` or `Refused`). * For other payment methods, you'll receive `redirectShopper` as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`. +PostPayments Starts a transaction. +Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response returns the result of the payment request: * For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. **Authorised** or **Refused**). * For other payment methods, you'll receive **RedirectShopper** as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`. * @param request PaymentRequest - reference of PaymentRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return PaymentResponse @@ -94,7 +160,20 @@ func (a Checkout) Payments(req *PaymentRequest, ctxs ..._context.Context) (Payme } /* -PaymentsResult Verifies payment result. +PostPaymentsDetails Submits details for a payment. +Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request (for example for 3D Secure, or when getting redirected back directly from a payment method using an app switch). The exact details, which need to be sent to this endpoint, are always specified in the response of the associated `/payments` request. In addition, the endpoint can be used to verify a `payload`, which is returned after coming back from the Checkout SDK or any of the redirect based methods on the Checkout API. + * @param request DetailsRequest - reference of DetailsRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return PaymentResponse +*/ +func (a Checkout) PaymentsDetails(req *DetailsRequest, ctxs ..._context.Context) (PaymentResponse, *_nethttp.Response, error) { + res := &PaymentResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/payments/details", ctxs...) + return *res, httpRes, err +} + +/* +PostPaymentsResult Verifies payment result. Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/checkout#howitworks). * @param request PaymentVerificationRequest - reference of PaymentVerificationRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). diff --git a/src/checkout/model_account_info.go b/src/checkout/model_account_info.go index ea2a299dc..0528caeb5 100644 --- a/src/checkout/model_account_info.go +++ b/src/checkout/model_account_info.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_ach_details.go b/src/checkout/model_ach_details.go new file mode 100644 index 000000000..b28378bba --- /dev/null +++ b/src/checkout/model_ach_details.go @@ -0,0 +1,30 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// AchDetails struct for AchDetails +type AchDetails struct { + // The bank account number (without separators). + BankAccountNumber string `json:"bankAccountNumber"` + // The bank routing number of the account. The field value is `nil` in most cases. + BankLocationId string `json:"bankLocationId,omitempty"` + // Encrypted bank account number. The bank account number (without separators). + EncryptedBankAccountNumber string `json:"encryptedBankAccountNumber,omitempty"` + // Encrypted location id. The bank routing number of the account. The field value is `nil` in most cases. + EncryptedBankLocationId string `json:"encryptedBankLocationId,omitempty"` + // The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: * χ12 is converted to ch12. * üA is converted to euA. * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: * John17 - allowed. * J17 - allowed. * 171 - not allowed. * John-7 - allowed. > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. + OwnerName string `json:"ownerName,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // **ach** + Type string `json:"type"` +} diff --git a/src/checkout/model_additional_data3_d_secure.go b/src/checkout/model_additional_data3_d_secure.go index e5d89fddd..fa99a98fe 100644 --- a/src/checkout/model_additional_data3_d_secure.go +++ b/src/checkout/model_additional_data3_d_secure.go @@ -1,23 +1,24 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package checkout - // AdditionalData3DSecure struct for AdditionalData3DSecure type AdditionalData3DSecure struct { - // This parameter indicates that you are able to process 3D Secure 2 transactions natively on your payment page. Send this field when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/checkout/3d-secure/native-3ds2), such as Components or Drop-in. Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration. > This parameter only indicates your readiness to support 3D Secure 2 natively on Drop-in or Components. To specify that you want to perform 3D Secure on a transaction, use Dynamic 3D Secure or send the executeThreeD parameter. + // Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/checkout/3d-secure/native-3ds2). > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter. Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration. Allow3DS2 string `json:"allow3DS2,omitempty"` - // This parameter indicates if you want to perform 3D Secure authentication on a transaction or not. Allowed values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. > Alternatively, you can also use Dynamic 3D Secure to configure rules for applying 3D Secure. + // Indicates if you want to perform 3D Secure authentication on a transaction. > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure. Possible values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. ExecuteThreeD string `json:"executeThreeD,omitempty"` // In case of Secure+, this field must be set to **CUPSecurePlus**. MpiImplementationType string `json:"mpiImplementationType,omitempty"` - // Indicates the [exemption type](https://docs-admin.is.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** + // Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** ScaExemption string `json:"scaExemption,omitempty"` + // Indicates your preference for the 3D Secure version. > If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure. Possible values: * **1.0.2**: Apply 3D Secure version 1.0.2. * **2.1.0**: Apply 3D Secure version 2.1.0. * **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0. The following rules apply: * If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2. * If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error. + ThreeDSVersion string `json:"threeDSVersion,omitempty"` } diff --git a/src/checkout/model_additional_data_airline.go b/src/checkout/model_additional_data_airline.go index 3d024551b..259ab892e 100644 --- a/src/checkout/model_additional_data_airline.go +++ b/src/checkout/model_additional_data_airline.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,60 +11,60 @@ package checkout // AdditionalDataAirline struct for AdditionalDataAirline type AdditionalDataAirline struct { - // Passenger name, initials, and a title. * Format: last name + first name or initials + title. * Example: *FLYER / MARY MS*. * minLength: 1 * maxLength: 49 - AirlinePassengerName string `json:"airline.passenger_name"` - // The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. * Format: alphanumeric. * minLength: 4 * maxLength: 4 - AirlineComputerizedReservationSystem string `json:"airline.computerized_reservation_system,omitempty"` + // Reference number for the invoice, issued by the agency. * minLength: 1 * maxLength: 6 + AirlineAgencyInvoiceNumber string `json:"airline.agency_invoice_number,omitempty"` + // 2-letter agency plan identifier; alphabetical. * minLength: 2 * maxLength: 2 + AirlineAgencyPlanName string `json:"airline.agency_plan_name,omitempty"` // [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier. * Format: IATA 3-digit accounting code (PAX) * Example: KLM = 074 * minLength: 3 * maxLength: 3 AirlineAirlineCode string `json:"airline.airline_code,omitempty"` - // The ticket's unique identifier. * minLength: 1 * maxLength: 150 - AirlineTicketNumber string `json:"airline.ticket_number,omitempty"` - // Flight departure date. Local time `(HH:mm)` is optional. * Date format: `yyyy-MM-dd` * Date and time format: `yyyy-MM-dd HH:mm` * minLength: 10 * maxLength: 16 - AirlineFlightDate string `json:"airline.flight_date,omitempty"` - // Reference number; alphanumeric. * minLength: 0 * maxLength: 20 - AirlineCustomerReferenceNumber string `json:"airline.customer_reference_number,omitempty"` - // Address of the place/agency that issued the ticket. * minLength: 0 * maxLength: 16 - AirlineTicketIssueAddress string `json:"airline.ticket_issue_address,omitempty"` // [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier. * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code * Example: KLM = KL * minLength: 2 * maxLength: 2 AirlineAirlineDesignatorCode string `json:"airline.airline_designator_code,omitempty"` - // IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies. * minLength: 1 * maxLength: 8 - AirlineTravelAgencyCode string `json:"airline.travel_agency_code,omitempty"` - // The name of the travel agency. * minLength: 1 * maxLength: 25 - AirlineTravelAgencyName string `json:"airline.travel_agency_name,omitempty"` - // 2-letter agency plan identifier; alphabetical. * minLength: 2 * maxLength: 2 - AirlineAgencyPlanName string `json:"airline.agency_plan_name,omitempty"` - // Reference number for the invoice, issued by the agency. * minLength: 1 * maxLength: 6 - AirlineAgencyInvoiceNumber string `json:"airline.agency_invoice_number,omitempty"` // Chargeable amount for boarding the plane. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). * minLength: 1 * maxLength: 18 AirlineBoardingFee string `json:"airline.boarding_fee,omitempty"` + // The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. * Format: alphanumeric. * minLength: 4 * maxLength: 4 + AirlineComputerizedReservationSystem string `json:"airline.computerized_reservation_system,omitempty"` + // Reference number; alphanumeric. * minLength: 0 * maxLength: 20 + AirlineCustomerReferenceNumber string `json:"airline.customer_reference_number,omitempty"` // Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements. * Format: 2-digit code * Example: Passenger ticket = 01 * minLength: 2 * maxLength: 2 AirlineDocumentType string `json:"airline.document_type,omitempty"` - // Alphabetical identifier of the departure airport. This field is required if the airline data includes leg details. * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. * Example: Amsterdam = AMS * minLength: 3 * maxLength: 3 - AirlineLegDepartAirport string `json:"airline.leg.depart_airport,omitempty"` - // The flight identifier. * minLength: 1 * maxLength: 5 - AirlineLegFlightNumber string `json:"airline.leg.flight_number,omitempty"` + // Flight departure date. Local time `(HH:mm)` is optional. * Date format: `yyyy-MM-dd` * Date and time format: `yyyy-MM-dd HH:mm` * minLength: 10 * maxLength: 16 + AirlineFlightDate string `json:"airline.flight_date,omitempty"` // [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier. This field is required/mandatory if the airline data includes leg details. * Format: IATA 2-letter airline code * Example: KLM = KL * minLength: 2 * maxLength: 2 AirlineLegCarrierCode string `json:"airline.leg.carrier_code,omitempty"` - // [Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric. * minLength: 1 * maxLength: 7 - AirlineLegFareBaseCode string `json:"airline.leg.fare_base_code,omitempty"` // 1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently: * F: first class * J: business class * Y: economy class * W: premium economy Limitations: * minLength: 1 * maxLength: 1 AirlineLegClassOfTravel string `json:"airline.leg.class_of_travel,omitempty"` - // 1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed: * O: Stopover allowed * X: Stopover not allowed Limitations: * minLength: 1 * maxLength: 1 - AirlineLegStopOverCode string `json:"airline.leg.stop_over_code,omitempty"` - // Alphabetical identifier of the destination/arrival airport. This field is required/mandatory if the airline data includes leg details. * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. * Example: Amsterdam = AMS * minLength: 3 * maxLength: 3 - AirlineLegDestinationCode string `json:"airline.leg.destination_code,omitempty"` // Date and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant. * Format: `yyyy-MM-dd HH:mm` * minLength: 16 * maxLength: 16 AirlineLegDateOfTravel string `json:"airline.leg.date_of_travel,omitempty"` + // Alphabetical identifier of the departure airport. This field is required if the airline data includes leg details. * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. * Example: Amsterdam = AMS * minLength: 3 * maxLength: 3 + AirlineLegDepartAirport string `json:"airline.leg.depart_airport,omitempty"` // [Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). * minLength: 1 * maxLength: 12 AirlineLegDepartTax string `json:"airline.leg.depart_tax,omitempty"` + // Alphabetical identifier of the destination/arrival airport. This field is required/mandatory if the airline data includes leg details. * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. * Example: Amsterdam = AMS * minLength: 3 * maxLength: 3 + AirlineLegDestinationCode string `json:"airline.leg.destination_code,omitempty"` + // [Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric. * minLength: 1 * maxLength: 7 + AirlineLegFareBaseCode string `json:"airline.leg.fare_base_code,omitempty"` + // The flight identifier. * minLength: 1 * maxLength: 5 + AirlineLegFlightNumber string `json:"airline.leg.flight_number,omitempty"` + // 1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed: * O: Stopover allowed * X: Stopover not allowed Limitations: * minLength: 1 * maxLength: 1 + AirlineLegStopOverCode string `json:"airline.leg.stop_over_code,omitempty"` + // Date of birth of the passenger. Date format: `yyyy-MM-dd` * minLength: 10 * maxLength: 10 + AirlinePassengerDateOfBirth string `json:"airline.passenger.date_of_birth,omitempty"` // Passenger first name/given name. > This field is required/mandatory if the airline data includes passenger details or leg details. AirlinePassengerFirstName string `json:"airline.passenger.first_name,omitempty"` // Passenger last name/family name. > This field is required/mandatory if the airline data includes passenger details or leg details. AirlinePassengerLastName string `json:"airline.passenger.last_name,omitempty"` - // Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS. However, several carriers use non-standard codes that can be up to 5 alphanumeric characters. * minLength: 3 * maxLength: 6 - AirlinePassengerTravellerType string `json:"airline.passenger.traveller_type,omitempty"` // Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs. * minLength: 3 * maxLength: 30 AirlinePassengerTelephoneNumber string `json:"airline.passenger.telephone_number,omitempty"` - // Date of birth of the passenger. Date format: `yyyy-MM-dd` * minLength: 10 * maxLength: 10 - AirlinePassengerDateOfBirth string `json:"airline.passenger.date_of_birth,omitempty"` + // Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS. However, several carriers use non-standard codes that can be up to 5 alphanumeric characters. * minLength: 3 * maxLength: 6 + AirlinePassengerTravellerType string `json:"airline.passenger.traveller_type,omitempty"` + // Passenger name, initials, and a title. * Format: last name + first name or initials + title. * Example: *FLYER / MARY MS*. * minLength: 1 * maxLength: 49 + AirlinePassengerName string `json:"airline.passenger_name"` + // Address of the place/agency that issued the ticket. * minLength: 0 * maxLength: 16 + AirlineTicketIssueAddress string `json:"airline.ticket_issue_address,omitempty"` + // The ticket's unique identifier. * minLength: 1 * maxLength: 150 + AirlineTicketNumber string `json:"airline.ticket_number,omitempty"` + // IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies. * minLength: 1 * maxLength: 8 + AirlineTravelAgencyCode string `json:"airline.travel_agency_code,omitempty"` + // The name of the travel agency. * minLength: 1 * maxLength: 25 + AirlineTravelAgencyName string `json:"airline.travel_agency_name,omitempty"` } diff --git a/src/checkout/model_additional_data_car_rental.go b/src/checkout/model_additional_data_car_rental.go index 7ab616ad2..98b7cbd50 100644 --- a/src/checkout/model_additional_data_car_rental.go +++ b/src/checkout/model_additional_data_car_rental.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,50 +11,50 @@ package checkout // AdditionalDataCarRental struct for AdditionalDataCarRental type AdditionalDataCarRental struct { - // The rental agreement number associated with this car rental. * Format: Alphanumeric * maxLength: 14 - CarRentalRentalAgreementNumber string `json:"carRental.rentalAgreementNumber,omitempty"` - // The name of the person renting the car. * Format: Alphanumeric * maxLength: 26 - CarRentalRenterName string `json:"carRental.renterName,omitempty"` - // The city where the car must be returned. * Format: Alphanumeric * maxLength: 18 - CarRentalReturnCity string `json:"carRental.returnCity,omitempty"` - // The state or province where the car must be returned. * Format: Alphanumeric * maxLength: 3 - CarRentalReturnStateProvince string `json:"carRental.returnStateProvince,omitempty"` - // The country where the car must be returned. * Format: Alphanumeric * maxLength: 2 - CarRentalReturnCountry string `json:"carRental.returnCountry,omitempty"` - // Agency code, phone number, or address abbreviation * Format: Alphanumeric * maxLength: 10 - CarRentalReturnLocationId string `json:"carRental.returnLocationId,omitempty"` - // The last date to return the car by. * Date format: `yyyyMMdd` - CarRentalReturnDate string `json:"carRental.returnDate,omitempty"` // Pick-up date. * Date format: `yyyyMMdd` CarRentalCheckOutDate string `json:"carRental.checkOutDate,omitempty"` // The customer service phone number of the car rental company. * Format: Alphanumeric * maxLength: 17 CarRentalCustomerServiceTollFreeNumber string `json:"carRental.customerServiceTollFreeNumber,omitempty"` + // Number of days for which the car is being rented. * Format: Numeric * maxLength: 19 + CarRentalDaysRented string `json:"carRental.daysRented,omitempty"` + // Any fuel charges associated with the rental. * Format: Numeric * maxLength: 12 + CarRentalFuelCharges string `json:"carRental.fuelCharges,omitempty"` + // Any insurance charges associated with the rental. * Format: Numeric * maxLength: 12 + CarRentalInsuranceCharges string `json:"carRental.insuranceCharges,omitempty"` + // The city from which the car is rented. * Format: Alphanumeric * maxLength: 18 + CarRentalLocationCity string `json:"carRental.locationCity,omitempty"` + // The country from which the car is rented. * Format: Alphanumeric * maxLength: 2 + CarRentalLocationCountry string `json:"carRental.locationCountry,omitempty"` + // The state or province from where the car is rented. * Format: Alphanumeric * maxLength: 3 + CarRentalLocationStateProvince string `json:"carRental.locationStateProvince,omitempty"` + // Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking). * Y - Customer was a no show. * N - Not applicable. + CarRentalNoShowIndicator string `json:"carRental.noShowIndicator,omitempty"` + // Charge associated with not returning a vehicle to the original rental location. + CarRentalOneWayDropOffCharges string `json:"carRental.oneWayDropOffCharges,omitempty"` // Daily rental rate. * Format: Alphanumeric * maxLength: 12 CarRentalRate string `json:"carRental.rate,omitempty"` // Specifies whether the given rate is applied daily or weekly. * D - Daily rate. * W - Weekly rate. CarRentalRateIndicator string `json:"carRental.rateIndicator,omitempty"` - // The location from which the car is rented. * Format: Alphanumeric * maxLength: 18 - CarRentalLocationCity string `json:"carRental.locationCity,omitempty"` - // Pick-up date. * Date format: `yyyyMMdd` - CarRentalLocationStateProvince string `json:"carRental.locationStateProvince,omitempty"` - // The customer service phone number of the car rental company. * Format: Alphanumeric * maxLength: 17 - CarRentalLocationCountry string `json:"carRental.locationCountry,omitempty"` + // The rental agreement number associated with this car rental. * Format: Alphanumeric * maxLength: 9 + CarRentalRentalAgreementNumber string `json:"carRental.rentalAgreementNumber,omitempty"` // Daily rental rate. * Format: Alphanumeric * maxLength: 12 CarRentalRentalClassId string `json:"carRental.rentalClassId,omitempty"` - // Specifies whether the given rate is applied daily or weekly. * D - Daily rate. * W - Weekly rate. - CarRentalDaysRented string `json:"carRental.daysRented,omitempty"` - // Indicates whether the goods or services were tax-exempt, or tax was not collected. Values: * 0 - Tax was not collected * 1 - Goods or services were tax exempt + // The name of the person renting the car. * Format: Alphanumeric * maxLength: 26 + CarRentalRenterName string `json:"carRental.renterName,omitempty"` + // The city where the car must be returned. * Format: Alphanumeric * maxLength: 18 + CarRentalReturnCity string `json:"carRental.returnCity,omitempty"` + // The country where the car must be returned. * Format: Alphanumeric * maxLength: 2 + CarRentalReturnCountry string `json:"carRental.returnCountry,omitempty"` + // The last date to return the car by. * Date format: `yyyyMMdd` + CarRentalReturnDate string `json:"carRental.returnDate,omitempty"` + // Agency code, phone number, or address abbreviation * Format: Alphanumeric * maxLength: 10 + CarRentalReturnLocationId string `json:"carRental.returnLocationId,omitempty"` + // The state or province where the car must be returned. * Format: Alphanumeric * maxLength: 3 + CarRentalReturnStateProvince string `json:"carRental.returnStateProvince,omitempty"` + // Indicates whether the goods or services were tax-exempt, or tax was not collected. Values: * Y - Goods or services were tax exempt * N - Tax was not collected CarRentalTaxExemptIndicator string `json:"carRental.taxExemptIndicator,omitempty"` - // Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1 - TravelEntertainmentAuthDataMarket string `json:"travelEntertainmentAuthData.market,omitempty"` // Number of nights. This should be included in the auth message. * Format: Numeric * maxLength: 2 TravelEntertainmentAuthDataDuration string `json:"travelEntertainmentAuthData.duration,omitempty"` - // Any fuel charges associated with the rental. * Format: Numeric * maxLength: 12 - CarRentalFuelCharges string `json:"carRental.fuelCharges,omitempty"` - // Any insurance charges associated with the rental. * Format: Numeric * maxLength: 12 - CarRentalInsuranceCharges string `json:"carRental.insuranceCharges,omitempty"` - // Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking). * 0 - Not applicable. * 1 - Customer was a no show. - CarRentalNoShowIndicator string `json:"carRental.noShowIndicator,omitempty"` - // Charge associated with not returning a vehicle to the original rental location. - CarRentalOneWayDropOffCharges string `json:"carRental.oneWayDropOffCharges,omitempty"` + // Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1 + TravelEntertainmentAuthDataMarket string `json:"travelEntertainmentAuthData.market,omitempty"` } diff --git a/src/checkout/model_additional_data_common.go b/src/checkout/model_additional_data_common.go index 9237395a5..74d64aaed 100644 --- a/src/checkout/model_additional_data_common.go +++ b/src/checkout/model_additional_data_common.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,16 +11,32 @@ package checkout // AdditionalDataCommon struct for AdditionalDataCommon type AdditionalDataCommon struct { + // Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response. + RequestedTestErrorResponseCode string `json:"RequestedTestErrorResponseCode,omitempty"` // Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/checkout/adjust-authorisation#authorisation-types). Allowed values: * **PreAuth** – flags the payment request to be handled as a pre-authorisation. * **FinalAuth** – flags the payment request to be handled as a final authorisation. AuthorisationType string `json:"authorisationType,omitempty"` // Allows you to determine or override the acquirer account that should be used for the transaction. If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new). CustomRoutingFlag string `json:"customRoutingFlag,omitempty"` - // Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardonFile** to ensure that the transaction is classified as MIT. + // In case of [asynchronous authorisation adjustment](https://docs.adyen.com/checkout/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made. Possible values: * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation. * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed. + IndustryUsage string `json:"industryUsage,omitempty"` + // Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT. NetworkTxReference string `json:"networkTxReference,omitempty"` // Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction. OverwriteBrand string `json:"overwriteBrand,omitempty"` - // Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response. - RequestedTestErrorResponseCode string `json:"RequestedTestErrorResponseCode,omitempty"` - // This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID, which is used by schemes to identify the merchant. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters. + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 13 characters. + SubMerchantCity string `json:"subMerchantCity,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. * Format: alpha-numeric. * Fixed length: 3 characters. + SubMerchantCountry string `json:"subMerchantCountry,omitempty"` + // This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters. SubMerchantID string `json:"subMerchantID,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. * Format: alpha-numeric. * Maximum length: 22 characters. + SubMerchantName string `json:"subMerchantName,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 10 characters. + SubMerchantPostalCode string `json:"subMerchantPostalCode,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 3 characters. + SubMerchantState string `json:"subMerchantState,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 60 characters. + SubMerchantStreet string `json:"subMerchantStreet,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. * Format: alpha-numeric. * Fixed length: 11 or 14 characters. + SubMerchantTaxId string `json:"subMerchantTaxId,omitempty"` } diff --git a/src/checkout/model_additional_data_level23.go b/src/checkout/model_additional_data_level23.go index 182ce8e65..68d1b53f0 100644 --- a/src/checkout/model_additional_data_level23.go +++ b/src/checkout/model_additional_data_level23.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,38 +11,38 @@ package checkout // AdditionalDataLevel23 struct for AdditionalDataLevel23 type AdditionalDataLevel23 struct { - // Customer code, if supplied by a customer. Encoding: ASCII. Max length: 25 characters. > Required for Level 2 and Level 3 data. + // Customer code, if supplied by a customer. Encoding: ASCII. Max length: 25 characters. > Required for Level 2 and Level 3 data. EnhancedSchemeDataCustomerReference string `json:"enhancedSchemeData.customerReference,omitempty"` - // Total tax amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. > Required for Level 2 and Level 3 data. - EnhancedSchemeDataTotalTaxAmount float32 `json:"enhancedSchemeData.totalTaxAmount,omitempty"` - // Shipping amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. - EnhancedSchemeDataFreightAmount float32 `json:"enhancedSchemeData.freightAmount,omitempty"` - // Duty amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. - EnhancedSchemeDataDutyAmount float32 `json:"enhancedSchemeData.dutyAmount,omitempty"` - // The postal code of a destination address. Encoding: ASCII. Max length: 10 characters. > Required for American Express. + // Destination country code. Encoding: ASCII. Max length: 3 characters. + EnhancedSchemeDataDestinationCountryCode string `json:"enhancedSchemeData.destinationCountryCode,omitempty"` + // The postal code of a destination address. Encoding: ASCII. Max length: 10 characters. > Required for American Express. EnhancedSchemeDataDestinationPostalCode string `json:"enhancedSchemeData.destinationPostalCode,omitempty"` // Destination state or province code. Encoding: ASCII.Max length: 3 characters. EnhancedSchemeDataDestinationStateProvinceCode string `json:"enhancedSchemeData.destinationStateProvinceCode,omitempty"` - // The postal code of a \"ship-from\" address. Encoding: ASCII. Max length: 10 characters. - EnhancedSchemeDataShipFromPostalCode string `json:"enhancedSchemeData.shipFromPostalCode,omitempty"` - // Destination country code. Encoding: ASCII. Max length: 3 characters. - EnhancedSchemeDataDestinationCountryCode string `json:"enhancedSchemeData.destinationCountryCode,omitempty"` - // Order date. * Format: `ddMMyy` Encoding: ASCII. Max length: 6 characters. - EnhancedSchemeDataOrderDate string `json:"enhancedSchemeData.orderDate,omitempty"` - // Item commodity code. Encoding: ASCII. Max length: 12 characters. + // Duty amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. + EnhancedSchemeDataDutyAmount string `json:"enhancedSchemeData.dutyAmount,omitempty"` + // Shipping amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. + EnhancedSchemeDataFreightAmount string `json:"enhancedSchemeData.freightAmount,omitempty"` + // Item commodity code. Encoding: ASCII. Max length: 12 characters. EnhancedSchemeDataItemDetailLineItemNrCommodityCode string `json:"enhancedSchemeData.itemDetailLine[itemNr].commodityCode,omitempty"` - // Item description. Encoding: ASCII. Max length: 26 characters. + // Item description. Encoding: ASCII. Max length: 26 characters. EnhancedSchemeDataItemDetailLineItemNrDescription string `json:"enhancedSchemeData.itemDetailLine[itemNr].description,omitempty"` - // Product code. Encoding: ASCII. Max length: 12 characters. + // Discount amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. + EnhancedSchemeDataItemDetailLineItemNrDiscountAmount string `json:"enhancedSchemeData.itemDetailLine[itemNr].discountAmount,omitempty"` + // Product code. Encoding: ASCII. Max length: 12 characters. EnhancedSchemeDataItemDetailLineItemNrProductCode string `json:"enhancedSchemeData.itemDetailLine[itemNr].productCode,omitempty"` - // Quantity, specified as an integer value. Value must be greater than 0. Max length: 12 characters. - EnhancedSchemeDataItemDetailLineItemNrQuantity float32 `json:"enhancedSchemeData.itemDetailLine[itemNr].quantity,omitempty"` - // Item unit of measurement. Encoding: ASCII. Max length: 3 characters. + // Quantity, specified as an integer value. Value must be greater than 0. Max length: 12 characters. + EnhancedSchemeDataItemDetailLineItemNrQuantity string `json:"enhancedSchemeData.itemDetailLine[itemNr].quantity,omitempty"` + // Total amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. + EnhancedSchemeDataItemDetailLineItemNrTotalAmount string `json:"enhancedSchemeData.itemDetailLine[itemNr].totalAmount,omitempty"` + // Item unit of measurement. Encoding: ASCII. Max length: 3 characters. EnhancedSchemeDataItemDetailLineItemNrUnitOfMeasure string `json:"enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure,omitempty"` - // Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). Max length: 12 characters. - EnhancedSchemeDataItemDetailLineItemNrUnitPrice float32 `json:"enhancedSchemeData.itemDetailLine[itemNr].unitPrice,omitempty"` - // Discount amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. - EnhancedSchemeDataItemDetailLineItemNrDiscountAmount float32 `json:"enhancedSchemeData.itemDetailLine[itemNr].discountAmount,omitempty"` - // Total amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. - EnhancedSchemeDataItemDetailLineItemNrTotalAmount float32 `json:"enhancedSchemeData.itemDetailLine[itemNr].totalAmount,omitempty"` + // Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). Max length: 12 characters. + EnhancedSchemeDataItemDetailLineItemNrUnitPrice string `json:"enhancedSchemeData.itemDetailLine[itemNr].unitPrice,omitempty"` + // Order date. * Format: `ddMMyy` Encoding: ASCII. Max length: 6 characters. + EnhancedSchemeDataOrderDate string `json:"enhancedSchemeData.orderDate,omitempty"` + // The postal code of a \"ship-from\" address. Encoding: ASCII. Max length: 10 characters. + EnhancedSchemeDataShipFromPostalCode string `json:"enhancedSchemeData.shipFromPostalCode,omitempty"` + // Total tax amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. > Required for Level 2 and Level 3 data. + EnhancedSchemeDataTotalTaxAmount string `json:"enhancedSchemeData.totalTaxAmount,omitempty"` } diff --git a/src/checkout/model_additional_data_lodging.go b/src/checkout/model_additional_data_lodging.go index a467ddd12..6bf622847 100644 --- a/src/checkout/model_additional_data_lodging.go +++ b/src/checkout/model_additional_data_lodging.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,38 +11,38 @@ package checkout // AdditionalDataLodging struct for AdditionalDataLodging type AdditionalDataLodging struct { - // The toll free phone number for the hotel/lodgings. * Format: Alphanumeric * maxLength: 17 - LodgingCustomerServiceTollFreeNumber string `json:"lodging.customerServiceTollFreeNumber,omitempty"` // The arrival date. * Date format: `yyyyMMdd` LodgingCheckInDate string `json:"lodging.checkInDate,omitempty"` // The departure date. * Date format: `yyyyMMdd` LodgingCheckOutDate string `json:"lodging.checkOutDate,omitempty"` - // Card acceptor’s internal invoice or billing ID reference number. * Format: Alphanumeric * maxLength: 25 - LodgingFolioNumber string `json:"lodging.folioNumber,omitempty"` - // Identifies specific lodging property location by its local phone number. * Format: Alphanumeric * maxLength: 17 - LodgingPropertyPhoneNumber string `json:"lodging.propertyPhoneNumber,omitempty"` - // The rate of the room. * Format: Numeric * maxLength: 12 - LodgingRoom1Rate string `json:"lodging.room1.rate,omitempty"` - // The total amount of tax to be paid. * Format: Numeric * maxLength: 12 - LodgingRoom1Tax string `json:"lodging.room1.tax,omitempty"` - // Total number of nights the room will be rented. * Format: Numeric * maxLength: 4 - LodgingRoom1NumberOfNights string `json:"lodging.room1.numberOfNights,omitempty"` + // The toll free phone number for the hotel/lodgings. * Format: Alphanumeric * maxLength: 17 + LodgingCustomerServiceTollFreeNumber string `json:"lodging.customerServiceTollFreeNumber,omitempty"` // Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'. * Format: Alphabetic * maxLength: 1 LodgingFireSafetyActIndicator string `json:"lodging.fireSafetyActIndicator,omitempty"` - // Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1 - TravelEntertainmentAuthDataMarket string `json:"travelEntertainmentAuthData.market,omitempty"` - // Number of nights. This should be included in the auth message. * Format: Numeric * maxLength: 2 - TravelEntertainmentAuthDataDuration string `json:"travelEntertainmentAuthData.duration,omitempty"` // The folio cash advances. * Format: Numeric * maxLength: 12 LodgingFolioCashAdvances string `json:"lodging.folioCashAdvances,omitempty"` + // Card acceptor’s internal invoice or billing ID reference number. * Format: Alphanumeric * maxLength: 25 + LodgingFolioNumber string `json:"lodging.folioNumber,omitempty"` // Any charges for food and beverages associated with the booking. * Format: Numeric * maxLength: 12 LodgingFoodBeverageCharges string `json:"lodging.foodBeverageCharges,omitempty"` // Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking). Value should be Y or N. * Format: Numeric * maxLength: 1 LodgingNoShowIndicator string `json:"lodging.noShowIndicator,omitempty"` // Prepaid expenses for the booking. * Format: Numeric * maxLength: 12 LodgingPrepaidExpenses string `json:"lodging.prepaidExpenses,omitempty"` - // Total tax amount. * Format: Numeric * maxLength: 12 - LodgingTotalTax string `json:"lodging.totalTax,omitempty"` + // Identifies specific lodging property location by its local phone number. * Format: Alphanumeric * maxLength: 17 + LodgingPropertyPhoneNumber string `json:"lodging.propertyPhoneNumber,omitempty"` + // Total number of nights the room will be rented. * Format: Numeric * maxLength: 4 + LodgingRoom1NumberOfNights string `json:"lodging.room1.numberOfNights,omitempty"` + // The rate of the room. * Format: Numeric * maxLength: 12 + LodgingRoom1Rate string `json:"lodging.room1.rate,omitempty"` + // The total amount of tax to be paid. * Format: Numeric * maxLength: 12 + LodgingRoom1Tax string `json:"lodging.room1.tax,omitempty"` // Total room tax amount. * Format: Numeric * maxLength: 12 LodgingTotalRoomTax string `json:"lodging.totalRoomTax,omitempty"` + // Total tax amount. * Format: Numeric * maxLength: 12 + LodgingTotalTax string `json:"lodging.totalTax,omitempty"` + // Number of nights. This should be included in the auth message. * Format: Numeric * maxLength: 2 + TravelEntertainmentAuthDataDuration string `json:"travelEntertainmentAuthData.duration,omitempty"` + // Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1 + TravelEntertainmentAuthDataMarket string `json:"travelEntertainmentAuthData.market,omitempty"` } diff --git a/src/checkout/model_additional_data_open_invoice.go b/src/checkout/model_additional_data_open_invoice.go index e8fc1777b..e15ac8821 100644 --- a/src/checkout/model_additional_data_open_invoice.go +++ b/src/checkout/model_additional_data_open_invoice.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,24 +11,24 @@ package checkout // AdditionalDataOpenInvoice struct for AdditionalDataOpenInvoice type AdditionalDataOpenInvoice struct { - // The number of invoice lines included in `openinvoicedata`. There needs to be at least one line, so `numberOfLines` needs to be at least 1. - OpeninvoicedataNumberOfLines int32 `json:"openinvoicedata.numberOfLines,omitempty"` // Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string. The `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end. Since the field is optional, if it's not included it does not impact computing the merchant signature. Applies only to Klarna. You can contact Klarna for the format and structure of the string. OpeninvoicedataMerchantData string `json:"openinvoicedata.merchantData,omitempty"` + // The number of invoice lines included in `openinvoicedata`. There needs to be at least one line, so `numberOfLines` needs to be at least 1. + OpeninvoicedataNumberOfLines string `json:"openinvoicedata.numberOfLines,omitempty"` // The three-character ISO currency code. - OpeninvoicedataLineItemNrCurrencyCode string `json:"openinvoicedata.line[itemNr].currencyCode,omitempty"` + OpeninvoicedataLineItemNrCurrencyCode string `json:"openinvoicedataLine[itemNr].currencyCode,omitempty"` // A text description of the product the invoice line refers to. - OpeninvoicedataLineItemNrDescription string `json:"openinvoicedata.line[itemNr].description,omitempty"` + OpeninvoicedataLineItemNrDescription string `json:"openinvoicedataLine[itemNr].description,omitempty"` // The price for one item in the invoice line, represented in minor units. The due amount for the item, VAT excluded. - OpeninvoicedataLineItemNrItemAmount int32 `json:"openinvoicedata.line[itemNr].itemAmount,omitempty"` + OpeninvoicedataLineItemNrItemAmount string `json:"openinvoicedataLine[itemNr].itemAmount,omitempty"` + // A unique id for this item. Required for RatePay if the description of each item is not unique. + OpeninvoicedataLineItemNrItemId string `json:"openinvoicedataLine[itemNr].itemId,omitempty"` // The VAT due for one item in the invoice line, represented in minor units. - OpeninvoicedataLineItemNrItemVatAmount int32 `json:"openinvoicedata.line[itemNr].itemVatAmount,omitempty"` + OpeninvoicedataLineItemNrItemVatAmount string `json:"openinvoicedataLine[itemNr].itemVatAmount,omitempty"` // The VAT percentage for one item in the invoice line, represented in minor units. For example, 19% VAT is specified as 1900. - OpeninvoicedataLineItemNrItemVatPercentage int32 `json:"openinvoicedata.line[itemNr].itemVatPercentage,omitempty"` - // A unique id for this item. Required for RatePay if the description of each item is not unique. - OpeninvoicedataLineItemNrItemId string `json:"openinvoicedata.line[itemNr].itemId,omitempty"` + OpeninvoicedataLineItemNrItemVatPercentage string `json:"openinvoicedataLine[itemNr].itemVatPercentage,omitempty"` // The number of units purchased of a specific product. - OpeninvoicedataLineItemNrNumberOfItems int32 `json:"openinvoicedata.line[itemNr].numberOfItems,omitempty"` + OpeninvoicedataLineItemNrNumberOfItems string `json:"openinvoicedataLine[itemNr].numberOfItems,omitempty"` // Required for AfterPay. The country-specific VAT category a product falls under. Allowed values: * High * Low * None. - OpeninvoicedataLineItemNrVatCategory string `json:"openinvoicedata.line[itemNr].vatCategory,omitempty"` + OpeninvoicedataLineItemNrVatCategory string `json:"openinvoicedataLine[itemNr].vatCategory,omitempty"` } diff --git a/src/checkout/model_additional_data_opi.go b/src/checkout/model_additional_data_opi.go new file mode 100644 index 000000000..51f0a1320 --- /dev/null +++ b/src/checkout/model_additional_data_opi.go @@ -0,0 +1,16 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// AdditionalDataOpi struct for AdditionalDataOpi +type AdditionalDataOpi struct { + // Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response. You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + OpiIncludeTransToken string `json:"opi.includeTransToken,omitempty"` +} diff --git a/src/checkout/model_additional_data_ratepay.go b/src/checkout/model_additional_data_ratepay.go index fb158da3c..bfdc7efba 100644 --- a/src/checkout/model_additional_data_ratepay.go +++ b/src/checkout/model_additional_data_ratepay.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,19 +12,19 @@ package checkout // AdditionalDataRatepay struct for AdditionalDataRatepay type AdditionalDataRatepay struct { // Amount the customer has to pay each month. - RatepayInstallmentAmount int32 `json:"ratepay.installmentAmount,omitempty"` + RatepayInstallmentAmount string `json:"ratepay.installmentAmount,omitempty"` + // Interest rate of this installment. + RatepayInterestRate string `json:"ratepay.interestRate,omitempty"` // Amount of the last installment. - RatepayLastInstallmentAmount int32 `json:"ratepay.lastInstallmentAmount,omitempty"` - // Interest rate of this installment. Double - RatepayInterestRate int32 `json:"ratepay.interestRate,omitempty"` + RatepayLastInstallmentAmount string `json:"ratepay.lastInstallmentAmount,omitempty"` // Calendar day of the first payment. - RatepayPaymentFirstday int32 `json:"ratepay.paymentFirstday,omitempty"` - // Identification name or number for the invoice, defined by the merchant. - RatepaydataInvoiceId string `json:"ratepaydata.invoiceId,omitempty"` - // Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date. - RatepaydataInvoiceDate string `json:"ratepaydata.invoiceDate,omitempty"` + RatepayPaymentFirstday string `json:"ratepay.paymentFirstday,omitempty"` // Date the merchant delivered the goods to the customer. RatepaydataDeliveryDate string `json:"ratepaydata.deliveryDate,omitempty"` // Date by which the customer must settle the payment. RatepaydataDueDate string `json:"ratepaydata.dueDate,omitempty"` + // Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date. + RatepaydataInvoiceDate string `json:"ratepaydata.invoiceDate,omitempty"` + // Identification name or number for the invoice, defined by the merchant. + RatepaydataInvoiceId string `json:"ratepaydata.invoiceId,omitempty"` } diff --git a/src/checkout/model_additional_data_retry.go b/src/checkout/model_additional_data_retry.go index 1a9fc8a5b..9c42e8a19 100644 --- a/src/checkout/model_additional_data_retry.go +++ b/src/checkout/model_additional_data_retry.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,10 +11,10 @@ package checkout // AdditionalDataRetry struct for AdditionalDataRetry type AdditionalDataRetry struct { - // The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - RetryChainAttemptNumber int32 `json:"retry.chainAttemptNumber,omitempty"` - // The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - RetryOrderAttemptNumber int32 `json:"retry.orderAttemptNumber,omitempty"` - // The Boolean value indicating whether Adyen should skip or retry this transaction, if possible. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - RetrySkipRetry bool `json:"retry.skipRetry,omitempty"` + // The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + RetryChainAttemptNumber string `json:"retry.chainAttemptNumber,omitempty"` + // The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + RetryOrderAttemptNumber string `json:"retry.orderAttemptNumber,omitempty"` + // The Boolean value indicating whether Adyen should skip or retry this transaction, if possible. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + RetrySkipRetry string `json:"retry.skipRetry,omitempty"` } diff --git a/src/checkout/model_additional_data_risk.go b/src/checkout/model_additional_data_risk.go index 4d358014f..744c53dc8 100644 --- a/src/checkout/model_additional_data_risk.go +++ b/src/checkout/model_additional_data_risk.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,40 +13,40 @@ package checkout type AdditionalDataRisk struct { // The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). RiskdataCustomFieldName string `json:"riskdata.[customFieldName],omitempty"` - // ID of the item. - RiskdataBasketItemItemNrItemID string `json:"riskdata.basket.item[itemNr].itemID,omitempty"` - // A text description of the product the invoice line refers to. - RiskdataBasketItemItemNrProductTitle string `json:"riskdata.basket.item[itemNr].productTitle,omitempty"` // The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). RiskdataBasketItemItemNrAmountPerItem string `json:"riskdata.basket.item[itemNr].amountPerItem,omitempty"` - // The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - RiskdataBasketItemItemNrCurrency string `json:"riskdata.basket.item[itemNr].currency,omitempty"` - // [Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code). - RiskdataBasketItemItemNrUpc string `json:"riskdata.basket.item[itemNr].upc,omitempty"` - // [Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit). - RiskdataBasketItemItemNrSku string `json:"riskdata.basket.item[itemNr].sku,omitempty"` // Brand of the item. RiskdataBasketItemItemNrBrand string `json:"riskdata.basket.item[itemNr].brand,omitempty"` - // Manufacturer of the item. - RiskdataBasketItemItemNrManufacturer string `json:"riskdata.basket.item[itemNr].manufacturer,omitempty"` // Category of the item. RiskdataBasketItemItemNrCategory string `json:"riskdata.basket.item[itemNr].category,omitempty"` // Color of the item. RiskdataBasketItemItemNrColor string `json:"riskdata.basket.item[itemNr].color,omitempty"` - // Size of the item. - RiskdataBasketItemItemNrSize string `json:"riskdata.basket.item[itemNr].size,omitempty"` + // The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + RiskdataBasketItemItemNrCurrency string `json:"riskdata.basket.item[itemNr].currency,omitempty"` + // ID of the item. + RiskdataBasketItemItemNrItemID string `json:"riskdata.basket.item[itemNr].itemID,omitempty"` + // Manufacturer of the item. + RiskdataBasketItemItemNrManufacturer string `json:"riskdata.basket.item[itemNr].manufacturer,omitempty"` + // A text description of the product the invoice line refers to. + RiskdataBasketItemItemNrProductTitle string `json:"riskdata.basket.item[itemNr].productTitle,omitempty"` // Quantity of the item purchased. RiskdataBasketItemItemNrQuantity string `json:"riskdata.basket.item[itemNr].quantity,omitempty"` // Email associated with the given product in the basket (usually in electronic gift cards). RiskdataBasketItemItemNrReceiverEmail string `json:"riskdata.basket.item[itemNr].receiverEmail,omitempty"` + // Size of the item. + RiskdataBasketItemItemNrSize string `json:"riskdata.basket.item[itemNr].size,omitempty"` + // [Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit). + RiskdataBasketItemItemNrSku string `json:"riskdata.basket.item[itemNr].sku,omitempty"` + // [Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code). + RiskdataBasketItemItemNrUpc string `json:"riskdata.basket.item[itemNr].upc,omitempty"` // Code of the promotion. RiskdataPromotionsPromotionItemNrPromotionCode string `json:"riskdata.promotions.promotion[itemNr].promotionCode,omitempty"` - // Name of the promotion. - RiskdataPromotionsPromotionItemNrPromotionName string `json:"riskdata.promotions.promotion[itemNr].promotionName,omitempty"` // The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). RiskdataPromotionsPromotionItemNrPromotionDiscountAmount string `json:"riskdata.promotions.promotion[itemNr].promotionDiscountAmount,omitempty"` // The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). RiskdataPromotionsPromotionItemNrPromotionDiscountCurrency string `json:"riskdata.promotions.promotion[itemNr].promotionDiscountCurrency,omitempty"` // Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign. e.g. for a promotion discount of 30%, the value of the field should be 30. RiskdataPromotionsPromotionItemNrPromotionDiscountPercentage string `json:"riskdata.promotions.promotion[itemNr].promotionDiscountPercentage,omitempty"` + // Name of the promotion. + RiskdataPromotionsPromotionItemNrPromotionName string `json:"riskdata.promotions.promotion[itemNr].promotionName,omitempty"` } diff --git a/src/checkout/model_additional_data_risk_standalone.go b/src/checkout/model_additional_data_risk_standalone.go index dca4fff75..fb398aea2 100644 --- a/src/checkout/model_additional_data_risk_standalone.go +++ b/src/checkout/model_additional_data_risk_standalone.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,6 +11,22 @@ package checkout // AdditionalDataRiskStandalone struct for AdditionalDataRiskStandalone type AdditionalDataRiskStandalone struct { + // Shopper's country of residence in the form of ISO standard 3166 2-character country codes. + PayPalCountryCode string `json:"PayPal.CountryCode,omitempty"` + // Shopper's email. + PayPalEmailId string `json:"PayPal.EmailId,omitempty"` + // Shopper's first name. + PayPalFirstName string `json:"PayPal.FirstName,omitempty"` + // Shopper's last name. + PayPalLastName string `json:"PayPal.LastName,omitempty"` + // Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters. + PayPalPayerId string `json:"PayPal.PayerId,omitempty"` + // Shopper's phone number. + PayPalPhone string `json:"PayPal.Phone,omitempty"` + // Allowed values: * **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. * **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. * **Ineligible** — Merchant is not protected under the Seller Protection Policy. + PayPalProtectionEligibility string `json:"PayPal.ProtectionEligibility,omitempty"` + // Unique transaction ID of the payment. + PayPalTransactionId string `json:"PayPal.TransactionId,omitempty"` // Raw AVS result received from the acquirer, where available. Example: D AvsResultRaw string `json:"avsResultRaw,omitempty"` // The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). @@ -18,27 +34,11 @@ type AdditionalDataRiskStandalone struct { // Raw CVC result received from the acquirer, where available. Example: 1 CvcResultRaw string `json:"cvcResultRaw,omitempty"` // Unique identifier or token for the shopper's card details. - RiskToken string `json:"risk.token,omitempty"` + RiskToken string `json:"riskToken,omitempty"` // A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true ThreeDAuthenticated string `json:"threeDAuthenticated,omitempty"` // A Boolean value indicating whether 3DS was offered for this payment. Example: true ThreeDOffered string `json:"threeDOffered,omitempty"` // Required for PayPal payments only. The only supported value is: **paypal**. TokenDataType string `json:"tokenDataType,omitempty"` - // Allowed values: * **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. * **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. * **Ineligible** — Merchant is not protected under the Seller Protection Policy. - PayPalProtectionEligibility string `json:"PayPal.ProtectionEligibility,omitempty"` - // Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters. - PayPalPayerId string `json:"PayPal.PayerId,omitempty"` - // Unique transaction ID of the payment. - PayPalTransactionId string `json:"PayPal.TransactionId,omitempty"` - // Shopper's country of residence in the form of ISO standard 3166 2-character country codes. - PayPalCountryCode string `json:"PayPal.CountryCode,omitempty"` - // Shopper's first name. - PayPalFirstName string `json:"PayPal.FirstName,omitempty"` - // Shopper's last name. - PayPalLastName string `json:"PayPal.LastName,omitempty"` - // Shopper's phone number. - PayPalPhone string `json:"PayPal.Phone,omitempty"` - // Shopper's email. - PayPalEmailId string `json:"PayPal.EmailId,omitempty"` } diff --git a/src/checkout/model_additional_data_temporary_services.go b/src/checkout/model_additional_data_temporary_services.go index 9d84126b9..e1d0bf17d 100644 --- a/src/checkout/model_additional_data_temporary_services.go +++ b/src/checkout/model_additional_data_temporary_services.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,20 +13,20 @@ package checkout type AdditionalDataTemporaryServices struct { // Customer code, if supplied by a customer. * Encoding: ASCII * maxLength: 25 EnhancedSchemeDataCustomerReference string `json:"enhancedSchemeData.customerReference,omitempty"` - // Total tax amount, in minor units. For example, 2000 means USD 20.00 * maxLength: 12 - EnhancedSchemeDataTotalTaxAmount string `json:"enhancedSchemeData.totalTaxAmount,omitempty"` // Name or ID associated with the individual working in a temporary capacity. * maxLength: 40 EnhancedSchemeDataEmployeeName string `json:"enhancedSchemeData.employeeName,omitempty"` // Description of the job or task of the individual working in a temporary capacity. * maxLength: 40 EnhancedSchemeDataJobDescription string `json:"enhancedSchemeData.jobDescription,omitempty"` + // Amount paid per regular hours worked, minor units. * maxLength: 7 + EnhancedSchemeDataRegularHoursRate string `json:"enhancedSchemeData.regularHoursRate,omitempty"` + // Amount of time worked during a normal operation for the task or job. * maxLength: 7 + EnhancedSchemeDataRegularHoursWorked string `json:"enhancedSchemeData.regularHoursWorked,omitempty"` + // Name of the individual requesting temporary services. * maxLength: 40 + EnhancedSchemeDataRequestName string `json:"enhancedSchemeData.requestName,omitempty"` // Date for the beginning of the pay period. * Format: ddMMyy * maxLength: 6 EnhancedSchemeDataTempStartDate string `json:"enhancedSchemeData.tempStartDate,omitempty"` // Date of the end of the billing cycle. * Format: ddMMyy * maxLength: 6 EnhancedSchemeDataTempWeekEnding string `json:"enhancedSchemeData.tempWeekEnding,omitempty"` - // Name of the individual requesting temporary services. * maxLength: 40 - EnhancedSchemeDataRequestName string `json:"enhancedSchemeData.requestName,omitempty"` - // Amount of time worked during a normal operation for the task or job. * maxLength: 7 - EnhancedSchemeDataRegularHoursWorked string `json:"enhancedSchemeData.regularHoursWorked,omitempty"` - // Amount paid per regular hours worked, minor units. * maxLength: 7 - EnhancedSchemeDataRegularHoursRate string `json:"enhancedSchemeData.regularHoursRate,omitempty"` + // Total tax amount, in minor units. For example, 2000 means USD 20.00 * maxLength: 12 + EnhancedSchemeDataTotalTaxAmount string `json:"enhancedSchemeData.totalTaxAmount,omitempty"` } diff --git a/src/checkout/model_additional_data_wallets.go b/src/checkout/model_additional_data_wallets.go index 08c259702..345e3d52b 100644 --- a/src/checkout/model_additional_data_wallets.go +++ b/src/checkout/model_additional_data_wallets.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_address.go b/src/checkout/model_address.go index ffea88744..1b77c5927 100644 --- a/src/checkout/model_address.go +++ b/src/checkout/model_address.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_amazon_pay_details.go b/src/checkout/model_amazon_pay_details.go new file mode 100644 index 000000000..dd161f546 --- /dev/null +++ b/src/checkout/model_amazon_pay_details.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// AmazonPayDetails struct for AmazonPayDetails +type AmazonPayDetails struct { + AmazonPayToken string `json:"amazonPayToken,omitempty"` + CheckoutSessionId string `json:"checkoutSessionId,omitempty"` + // **amazonpay** + Type string `json:"type"` +} diff --git a/src/checkout/model_amount.go b/src/checkout/model_amount.go index a33a17e4b..49a79f677 100644 --- a/src/checkout/model_amount.go +++ b/src/checkout/model_amount.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,6 +13,6 @@ package checkout type Amount struct { // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). Currency string `json:"currency"` - // The payable amount that can be charged for the transaction. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + // The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). Value int64 `json:"value"` } diff --git a/src/checkout/model_android_pay_details.go b/src/checkout/model_android_pay_details.go new file mode 100644 index 000000000..a49d90551 --- /dev/null +++ b/src/checkout/model_android_pay_details.go @@ -0,0 +1,17 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// AndroidPayDetails struct for AndroidPayDetails +type AndroidPayDetails struct { + AndroidPayToken string `json:"androidPayToken"` + // **androidpay** + Type string `json:"type"` +} diff --git a/src/checkout/model_apple_pay_details.go b/src/checkout/model_apple_pay_details.go new file mode 100644 index 000000000..74e1b10a1 --- /dev/null +++ b/src/checkout/model_apple_pay_details.go @@ -0,0 +1,23 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// ApplePayDetails struct for ApplePayDetails +type ApplePayDetails struct { + ApplePayToken string `json:"applePayToken"` + // The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + FundingSource string `json:"fundingSource,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // **applepay** + Type string `json:"type"` +} diff --git a/src/checkout/model_application_info.go b/src/checkout/model_application_info.go index aa0698003..f3aea4320 100644 --- a/src/checkout/model_application_info.go +++ b/src/checkout/model_application_info.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_avs.go b/src/checkout/model_avs.go index f4eceb838..5fefb0173 100644 --- a/src/checkout/model_avs.go +++ b/src/checkout/model_avs.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_bacs_direct_debit_details.go b/src/checkout/model_bacs_direct_debit_details.go new file mode 100644 index 000000000..dd519e266 --- /dev/null +++ b/src/checkout/model_bacs_direct_debit_details.go @@ -0,0 +1,22 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// BacsDirectDebitDetails struct for BacsDirectDebitDetails +type BacsDirectDebitDetails struct { + // The bank account number (without separators). + BankAccountNumber string `json:"bankAccountNumber"` + // The bank routing number of the account. + BankLocationId string `json:"bankLocationId"` + // The name of the bank account holder. + HolderName string `json:"holderName"` + // **directdebit_GB** + Type string `json:"type"` +} diff --git a/src/checkout/model_bank_account.go b/src/checkout/model_bank_account.go index a2419de98..58a0884d4 100644 --- a/src/checkout/model_bank_account.go +++ b/src/checkout/model_bank_account.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_bill_desk_online_details.go b/src/checkout/model_bill_desk_online_details.go new file mode 100644 index 000000000..4ebc047e3 --- /dev/null +++ b/src/checkout/model_bill_desk_online_details.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// BillDeskOnlineDetails struct for BillDeskOnlineDetails +type BillDeskOnlineDetails struct { + // The issuer id of the shopper's selected bank. + Issuer string `json:"issuer"` + // **billdesk_online** + Type string `json:"type"` +} diff --git a/src/checkout/model_bill_desk_wallet_details.go b/src/checkout/model_bill_desk_wallet_details.go new file mode 100644 index 000000000..34049cf79 --- /dev/null +++ b/src/checkout/model_bill_desk_wallet_details.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// BillDeskWalletDetails struct for BillDeskWalletDetails +type BillDeskWalletDetails struct { + // The issuer id of the shopper's selected bank. + Issuer string `json:"issuer"` + // **billdesk_wallet** + Type string `json:"type"` +} diff --git a/src/checkout/model_blik_details.go b/src/checkout/model_blik_details.go new file mode 100644 index 000000000..ae30dd3e6 --- /dev/null +++ b/src/checkout/model_blik_details.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// BlikDetails struct for BlikDetails +type BlikDetails struct { + // BLIK code consisting of 6 digits. + BlikCode string `json:"blikCode,omitempty"` + // **blik** + Type string `json:"type"` +} diff --git a/src/checkout/model_browser_info.go b/src/checkout/model_browser_info.go index 2655d13e8..18765d3a6 100644 --- a/src/checkout/model_browser_info.go +++ b/src/checkout/model_browser_info.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,7 +13,7 @@ package checkout type BrowserInfo struct { // The accept header value of the shopper's browser. AcceptHeader string `json:"acceptHeader"` - // The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 32 or 48 bit color depth. + // The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth. ColorDepth int32 `json:"colorDepth"` // Boolean value indicating if the shopper's browser is able to execute Java. JavaEnabled bool `json:"javaEnabled"` diff --git a/src/checkout/model_card.go b/src/checkout/model_card.go index dca40d7bc..bcedd6a1a 100644 --- a/src/checkout/model_card.go +++ b/src/checkout/model_card.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_card_details.go b/src/checkout/model_card_details.go new file mode 100644 index 000000000..bee03e78d --- /dev/null +++ b/src/checkout/model_card_details.go @@ -0,0 +1,32 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CardDetails struct for CardDetails +type CardDetails struct { + // Brand of the card. For example: **plastix**, **hmclub**. + Brand string `json:"brand,omitempty"` + CupsecureplusSmscode string `json:"cupsecureplus.smscode,omitempty"` + Cvc string `json:"cvc,omitempty"` + EncryptedCardNumber string `json:"encryptedCardNumber"` + EncryptedExpiryMonth string `json:"encryptedExpiryMonth"` + EncryptedExpiryYear string `json:"encryptedExpiryYear"` + ExpiryMonth string `json:"expiryMonth,omitempty"` + ExpiryYear string `json:"expiryYear,omitempty"` + FundingSource string `json:"fundingSource,omitempty"` + HolderName string `json:"holderName,omitempty"` + Number string `json:"number,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // **scheme** + Type string `json:"type"` +} diff --git a/src/checkout/model_cellulant_details.go b/src/checkout/model_cellulant_details.go new file mode 100644 index 000000000..1020a1216 --- /dev/null +++ b/src/checkout/model_cellulant_details.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CellulantDetails struct for CellulantDetails +type CellulantDetails struct { + // The issuer's ID + IssuerId string `json:"issuerId,omitempty"` + // **Cellulant** + Type string `json:"type"` +} diff --git a/src/checkout/model_checkout_await_action.go b/src/checkout/model_checkout_await_action.go new file mode 100644 index 000000000..0bc898316 --- /dev/null +++ b/src/checkout/model_checkout_await_action.go @@ -0,0 +1,20 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutAwaitAction struct for CheckoutAwaitAction +type CheckoutAwaitAction struct { + // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. + PaymentData string `json:"paymentData,omitempty"` + // Specifies the payment method. + PaymentMethodType string `json:"paymentMethodType,omitempty"` + // Specifies the URL to redirect to. + Url string `json:"url,omitempty"` +} diff --git a/src/checkout/model_checkout_balance_check_request.go b/src/checkout/model_checkout_balance_check_request.go new file mode 100644 index 000000000..172503ed0 --- /dev/null +++ b/src/checkout/model_checkout_balance_check_request.go @@ -0,0 +1,92 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout + +import ( + "time" +) + +// CheckoutBalanceCheckRequest struct for CheckoutBalanceCheckRequest +type CheckoutBalanceCheckRequest struct { + AccountInfo *AccountInfo `json:"accountInfo,omitempty"` + AdditionalAmount *Amount `json:"additionalAmount,omitempty"` + // This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` + Amount *Amount `json:"amount,omitempty"` + ApplicationInfo *ApplicationInfo `json:"applicationInfo,omitempty"` + BillingAddress *Address `json:"billingAddress,omitempty"` + BrowserInfo *BrowserInfo `json:"browserInfo,omitempty"` + // The delay between the authorisation and scheduled auto-capture, specified in hours. + CaptureDelayHours int32 `json:"captureDelayHours,omitempty"` + // The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + DateOfBirth *time.Time `json:"dateOfBirth,omitempty"` + DccQuote *ForexQuote `json:"dccQuote,omitempty"` + DeliveryAddress *Address `json:"deliveryAddress,omitempty"` + // The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 + DeliveryDate *time.Time `json:"deliveryDate,omitempty"` + // A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + DeviceFingerprint string `json:"deviceFingerprint,omitempty"` + // An integer value that is added to the normal fraud score. The value can be either positive or negative. + FraudOffset int32 `json:"fraudOffset,omitempty"` + Installments *Installments `json:"installments,omitempty"` + // The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + Mcc string `json:"mcc,omitempty"` + // The merchant account identifier, with which you want to process the transaction. + MerchantAccount string `json:"merchantAccount"` + // This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + MerchantOrderReference string `json:"merchantOrderReference,omitempty"` + MerchantRiskIndicator *MerchantRiskIndicator `json:"merchantRiskIndicator,omitempty"` + // Metadata consists of entries, each of which includes a key and a value. Limitations: Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". + Metadata map[string]string `json:"metadata,omitempty"` + // When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. + OrderReference string `json:"orderReference,omitempty"` + // The collection that contains the type of the payment method and its specific information. + PaymentMethod map[string]interface{} `json:"paymentMethod"` + Recurring *Recurring `json:"recurring,omitempty"` + // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + RecurringProcessingModel string `json:"recurringProcessingModel,omitempty"` + // The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + Reference string `json:"reference,omitempty"` + // Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card. + SelectedBrand string `json:"selectedBrand,omitempty"` + // The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. + SelectedRecurringDetailReference string `json:"selectedRecurringDetailReference,omitempty"` + // A session ID used to identify a payment session. + SessionId string `json:"sessionId,omitempty"` + // The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require the `shopperEmail` for both `deviceChannel` **browser** and **app**. + ShopperEmail string `json:"shopperEmail,omitempty"` + // The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > Required for 3D Secure 2 transactions. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new). + ShopperIP string `json:"shopperIP,omitempty"` + // Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + ShopperInteraction string `json:"shopperInteraction,omitempty"` + // The combination of a language code and a country code to specify the language to be used in the payment. + ShopperLocale string `json:"shopperLocale,omitempty"` + ShopperName *Name `json:"shopperName,omitempty"` + // Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. + ShopperReference string `json:"shopperReference,omitempty"` + // The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. + ShopperStatement string `json:"shopperStatement,omitempty"` + // The shopper's social security number. + SocialSecurityNumber string `json:"socialSecurityNumber,omitempty"` + // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + Splits *[]Split `json:"splits,omitempty"` + // The physical store, for which this payment is processed. + Store string `json:"store,omitempty"` + // The shopper's telephone number. + TelephoneNumber string `json:"telephoneNumber,omitempty"` + ThreeDS2RequestData *ThreeDS2RequestData `json:"threeDS2RequestData,omitempty"` + // If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + ThreeDSAuthenticationOnly bool `json:"threeDSAuthenticationOnly,omitempty"` + // The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). + TotalsGroup string `json:"totalsGroup,omitempty"` + // Set to true if the payment should be routed to a trusted MID. + TrustedShopper bool `json:"trustedShopper,omitempty"` +} diff --git a/src/checkout/model_checkout_balance_check_response.go b/src/checkout/model_checkout_balance_check_response.go new file mode 100644 index 000000000..db48d9bd7 --- /dev/null +++ b/src/checkout/model_checkout_balance_check_response.go @@ -0,0 +1,26 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout + +// CheckoutBalanceCheckResponse struct for CheckoutBalanceCheckResponse +type CheckoutBalanceCheckResponse struct { + // This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**. + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` + Balance Amount `json:"balance"` + FraudResult *FraudResult `json:"fraudResult,omitempty"` + // Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > `pspReference` is returned only for non-redirect payment methods. + PspReference string `json:"pspReference,omitempty"` + // If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + RefusalReason string `json:"refusalReason,omitempty"` + // The result of the payment. For more information, see [Result codes](https://docs.adyen.com/checkout/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + ResultCode string `json:"resultCode,omitempty"` + TransactionLimit *Amount `json:"transactionLimit,omitempty"` +} diff --git a/src/checkout/model_checkout_cancel_order_request.go b/src/checkout/model_checkout_cancel_order_request.go new file mode 100644 index 000000000..fc0dff987 --- /dev/null +++ b/src/checkout/model_checkout_cancel_order_request.go @@ -0,0 +1,17 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutCancelOrderRequest struct for CheckoutCancelOrderRequest +type CheckoutCancelOrderRequest struct { + // The merchant account identifier that orderData belongs to. + MerchantAccount string `json:"merchantAccount"` + Order CheckoutOrder `json:"order"` +} diff --git a/src/checkout/model_checkout_cancel_order_response.go b/src/checkout/model_checkout_cancel_order_response.go new file mode 100644 index 000000000..78f94369c --- /dev/null +++ b/src/checkout/model_checkout_cancel_order_response.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutCancelOrderResponse struct for CheckoutCancelOrderResponse +type CheckoutCancelOrderResponse struct { + // A unique reference of the cancellation request. + PspReference string `json:"pspReference"` + // The result of the cancellation request. + ResultCode string `json:"resultCode"` +} diff --git a/src/checkout/model_checkout_create_order_request.go b/src/checkout/model_checkout_create_order_request.go new file mode 100644 index 000000000..ab60f2de4 --- /dev/null +++ b/src/checkout/model_checkout_create_order_request.go @@ -0,0 +1,21 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutCreateOrderRequest struct for CheckoutCreateOrderRequest +type CheckoutCreateOrderRequest struct { + Amount Amount `json:"amount"` + // The date that order expires; e.g. 2019-03-23T12:25:28Z. If not provided, the default expiry duration is 1 day. + ExpiresAt string `json:"expiresAt,omitempty"` + // The merchant account identifier, with which you want to process the order. + MerchantAccount string `json:"merchantAccount"` + // A custom reference identifying the order. + Reference string `json:"reference,omitempty"` +} diff --git a/src/checkout/model_checkout_create_order_response.go b/src/checkout/model_checkout_create_order_response.go new file mode 100644 index 000000000..5fd30a75e --- /dev/null +++ b/src/checkout/model_checkout_create_order_response.go @@ -0,0 +1,29 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout + +// CheckoutCreateOrderResponse struct for CheckoutCreateOrderResponse +type CheckoutCreateOrderResponse struct { + // This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**. + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` + // The date that the order will expire. + ExpiresAt string `json:"expiresAt"` + FraudResult *FraudResult `json:"fraudResult,omitempty"` + // The encrypted data that will be used by merchant for adding payments to the order. + OrderData string `json:"orderData"` + // Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > `pspReference` is returned only for non-redirect payment methods. + PspReference string `json:"pspReference,omitempty"` + // If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + RefusalReason string `json:"refusalReason,omitempty"` + RemainingAmount Amount `json:"remainingAmount"` + // The result of the payment. For more information, see [Result codes](https://docs.adyen.com/checkout/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + ResultCode string `json:"resultCode,omitempty"` +} diff --git a/src/checkout/model_checkout_donation_action.go b/src/checkout/model_checkout_donation_action.go new file mode 100644 index 000000000..531cff960 --- /dev/null +++ b/src/checkout/model_checkout_donation_action.go @@ -0,0 +1,20 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutDonationAction struct for CheckoutDonationAction +type CheckoutDonationAction struct { + // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. + PaymentData string `json:"paymentData,omitempty"` + // Specifies the payment method. + PaymentMethodType string `json:"paymentMethodType,omitempty"` + // Specifies the URL to redirect to. + Url string `json:"url,omitempty"` +} diff --git a/src/checkout/model_checkout_one_time_passcode_action.go b/src/checkout/model_checkout_one_time_passcode_action.go new file mode 100644 index 000000000..323d3230b --- /dev/null +++ b/src/checkout/model_checkout_one_time_passcode_action.go @@ -0,0 +1,27 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutOneTimePasscodeAction struct for CheckoutOneTimePasscodeAction +type CheckoutOneTimePasscodeAction struct { + // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. + PaymentData string `json:"paymentData,omitempty"` + // Specifies the payment method. + PaymentMethodType string `json:"paymentMethodType,omitempty"` + Redirect *Redirect `json:"redirect,omitempty"` + // The interval in second between OTP resend. + ResendInterval int32 `json:"resendInterval,omitempty"` + // The maximum number of OTP resend attempts. + ResendMaxAttempts int32 `json:"resendMaxAttempts,omitempty"` + // The URL, to which you make POST request to trigger OTP resend. + ResendUrl string `json:"resendUrl,omitempty"` + // Specifies the URL to redirect to. + Url string `json:"url,omitempty"` +} diff --git a/src/checkout/model_checkout_order.go b/src/checkout/model_checkout_order.go new file mode 100644 index 000000000..e59c0b960 --- /dev/null +++ b/src/checkout/model_checkout_order.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutOrder struct for CheckoutOrder +type CheckoutOrder struct { + // The encrypted order data. + OrderData string `json:"orderData"` + // The `pspReference` that belongs to the order. + PspReference string `json:"pspReference"` +} diff --git a/src/checkout/model_checkout_order_response.go b/src/checkout/model_checkout_order_response.go new file mode 100644 index 000000000..e85dbd7ab --- /dev/null +++ b/src/checkout/model_checkout_order_response.go @@ -0,0 +1,23 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutOrderResponse struct for CheckoutOrderResponse +type CheckoutOrderResponse struct { + // The expiry date for the order. + ExpiresAt string `json:"expiresAt,omitempty"` + // The encrypted order data. + OrderData string `json:"orderData,omitempty"` + // The `pspReference` that belongs to the order. + PspReference string `json:"pspReference"` + // The merchant reference for the order. + Reference string `json:"reference,omitempty"` + RemainingAmount *Amount `json:"remainingAmount,omitempty"` +} diff --git a/src/checkout/model_checkout_qr_code_action.go b/src/checkout/model_checkout_qr_code_action.go new file mode 100644 index 000000000..672f0c88d --- /dev/null +++ b/src/checkout/model_checkout_qr_code_action.go @@ -0,0 +1,22 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutQrCodeAction struct for CheckoutQrCodeAction +type CheckoutQrCodeAction struct { + // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. + PaymentData string `json:"paymentData,omitempty"` + // Specifies the payment method. + PaymentMethodType string `json:"paymentMethodType,omitempty"` + // The contents of the QR code as a UTF8 string. + QrCodeData string `json:"qrCodeData,omitempty"` + // Specifies the URL to redirect to. + Url string `json:"url,omitempty"` +} diff --git a/src/checkout/model_checkout_redirect_action.go b/src/checkout/model_checkout_redirect_action.go new file mode 100644 index 000000000..0e88eeb4f --- /dev/null +++ b/src/checkout/model_checkout_redirect_action.go @@ -0,0 +1,24 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutRedirectAction struct for CheckoutRedirectAction +type CheckoutRedirectAction struct { + // When the redirect URL must be accessed via POST, use this data to post to the redirect URL. + Data map[string]string `json:"data,omitempty"` + // Specifies the HTTP method, for example GET or POST. + Method string `json:"method,omitempty"` + // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. + PaymentData string `json:"paymentData,omitempty"` + // Specifies the payment method. + PaymentMethodType string `json:"paymentMethodType,omitempty"` + // Specifies the URL to redirect to. + Url string `json:"url,omitempty"` +} diff --git a/src/checkout/model_checkout_sdk_action.go b/src/checkout/model_checkout_sdk_action.go new file mode 100644 index 000000000..9a5530345 --- /dev/null +++ b/src/checkout/model_checkout_sdk_action.go @@ -0,0 +1,22 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutSDKAction struct for CheckoutSDKAction +type CheckoutSDKAction struct { + // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. + PaymentData string `json:"paymentData,omitempty"` + // Specifies the payment method. + PaymentMethodType string `json:"paymentMethodType,omitempty"` + // The data to pass to the SDK. + SdkData map[string]string `json:"sdkData,omitempty"` + // Specifies the URL to redirect to. + Url string `json:"url,omitempty"` +} diff --git a/src/checkout/model_checkout_three_ds2_action.go b/src/checkout/model_checkout_three_ds2_action.go new file mode 100644 index 000000000..290948bfc --- /dev/null +++ b/src/checkout/model_checkout_three_ds2_action.go @@ -0,0 +1,24 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutThreeDS2Action struct for CheckoutThreeDS2Action +type CheckoutThreeDS2Action struct { + // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. + PaymentData string `json:"paymentData,omitempty"` + // Specifies the payment method. + PaymentMethodType string `json:"paymentMethodType,omitempty"` + // A sub type of the token + Subtype string `json:"subtype,omitempty"` + // A token to pass to the 3DS2 Component to get the fingerprint. + Token string `json:"token,omitempty"` + // Specifies the URL to redirect to. + Url string `json:"url,omitempty"` +} diff --git a/src/checkout/model_checkout_three_ds2_challenge_action.go b/src/checkout/model_checkout_three_ds2_challenge_action.go new file mode 100644 index 000000000..6ffde2590 --- /dev/null +++ b/src/checkout/model_checkout_three_ds2_challenge_action.go @@ -0,0 +1,22 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutThreeDS2ChallengeAction struct for CheckoutThreeDS2ChallengeAction +type CheckoutThreeDS2ChallengeAction struct { + // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. + PaymentData string `json:"paymentData,omitempty"` + // Specifies the payment method. + PaymentMethodType string `json:"paymentMethodType,omitempty"` + // A token to pass to the 3DS2 Component to get the challenge. + Token string `json:"token,omitempty"` + // Specifies the URL to redirect to. + Url string `json:"url,omitempty"` +} diff --git a/src/checkout/model_checkout_three_ds2_finger_print_action.go b/src/checkout/model_checkout_three_ds2_finger_print_action.go new file mode 100644 index 000000000..166815b95 --- /dev/null +++ b/src/checkout/model_checkout_three_ds2_finger_print_action.go @@ -0,0 +1,22 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutThreeDS2FingerPrintAction struct for CheckoutThreeDS2FingerPrintAction +type CheckoutThreeDS2FingerPrintAction struct { + // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. + PaymentData string `json:"paymentData,omitempty"` + // Specifies the payment method. + PaymentMethodType string `json:"paymentMethodType,omitempty"` + // A token to pass to the 3DS2 Component to get the fingerprint. + Token string `json:"token,omitempty"` + // Specifies the URL to redirect to. + Url string `json:"url,omitempty"` +} diff --git a/src/checkout/model_checkout_utility_request.go b/src/checkout/model_checkout_utility_request.go new file mode 100644 index 000000000..35fcea84b --- /dev/null +++ b/src/checkout/model_checkout_utility_request.go @@ -0,0 +1,16 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutUtilityRequest struct for CheckoutUtilityRequest +type CheckoutUtilityRequest struct { + // The list of origin domains, for which origin keys are requested. + OriginDomains []string `json:"originDomains"` +} diff --git a/src/checkout/model_checkout_utility_response.go b/src/checkout/model_checkout_utility_response.go new file mode 100644 index 000000000..1c6e9bbe1 --- /dev/null +++ b/src/checkout/model_checkout_utility_response.go @@ -0,0 +1,16 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutUtilityResponse struct for CheckoutUtilityResponse +type CheckoutUtilityResponse struct { + // The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. + OriginKeys map[string]string `json:"originKeys,omitempty"` +} diff --git a/src/checkout/model_checkout_voucher_action.go b/src/checkout/model_checkout_voucher_action.go new file mode 100644 index 000000000..972130aee --- /dev/null +++ b/src/checkout/model_checkout_voucher_action.go @@ -0,0 +1,49 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// CheckoutVoucherAction struct for CheckoutVoucherAction +type CheckoutVoucherAction struct { + // The voucher alternative reference code. + AlternativeReference string `json:"alternativeReference,omitempty"` + // A collection institution number (store number) for Econtext Pay-Easy ATM. + CollectionInstitutionNumber string `json:"collectionInstitutionNumber,omitempty"` + // The URL to download the voucher. + DownloadUrl string `json:"downloadUrl,omitempty"` + // An entity number of Multibanco. + Entity string `json:"entity,omitempty"` + // The date time of the voucher expiry. + ExpiresAt string `json:"expiresAt,omitempty"` + InitialAmount *Amount `json:"initialAmount,omitempty"` + // The URL to the detailed instructions to make payment using the voucher. + InstructionsUrl string `json:"instructionsUrl,omitempty"` + // The issuer of the voucher. + Issuer string `json:"issuer,omitempty"` + // The shopper telephone number (partially masked). + MaskedTelephoneNumber string `json:"maskedTelephoneNumber,omitempty"` + // The merchant name. + MerchantName string `json:"merchantName,omitempty"` + // The merchant reference. + MerchantReference string `json:"merchantReference,omitempty"` + // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling. + PaymentData string `json:"paymentData,omitempty"` + // Specifies the payment method. + PaymentMethodType string `json:"paymentMethodType,omitempty"` + // The voucher reference code. + Reference string `json:"reference,omitempty"` + // The shopper email. + ShopperEmail string `json:"shopperEmail,omitempty"` + // The shopper name. + ShopperName string `json:"shopperName,omitempty"` + Surcharge *Amount `json:"surcharge,omitempty"` + TotalAmount *Amount `json:"totalAmount,omitempty"` + // Specifies the URL to redirect to. + Url string `json:"url,omitempty"` +} diff --git a/src/checkout/model_common_field.go b/src/checkout/model_common_field.go index 01e969599..2e628587d 100644 --- a/src/checkout/model_common_field.go +++ b/src/checkout/model_common_field.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_company.go b/src/checkout/model_company.go index d708ca62d..000540f85 100644 --- a/src/checkout/model_company.go +++ b/src/checkout/model_company.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_configuration.go b/src/checkout/model_configuration.go index a177f926a..7b0b8ccb5 100644 --- a/src/checkout/model_configuration.go +++ b/src/checkout/model_configuration.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_create_payment_link_request.go b/src/checkout/model_create_payment_link_request.go index 994c7da2a..b66963f50 100644 --- a/src/checkout/model_create_payment_link_request.go +++ b/src/checkout/model_create_payment_link_request.go @@ -1,46 +1,63 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package checkout - +import ( + "time" +) // CreatePaymentLinkRequest struct for CreatePaymentLinkRequest type CreatePaymentLinkRequest struct { // List of payments methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` AllowedPaymentMethods []string `json:"allowedPaymentMethods,omitempty"` - Amount Amount `json:"amount"` - BillingAddress *Address `json:"billingAddress,omitempty"` + Amount Amount `json:"amount"` + ApplicationInfo *ApplicationInfo `json:"applicationInfo,omitempty"` + BillingAddress *Address `json:"billingAddress,omitempty"` // List of payments methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]` BlockedPaymentMethods []string `json:"blockedPaymentMethods,omitempty"` - // The shopper's country code. - CountryCode string `json:"countryCode"` + // The shopper's two-letter country code. + CountryCode string `json:"countryCode,omitempty"` + // The date and time the purchased goods should be delivered. + DeliverAt *time.Time `json:"deliverAt,omitempty"` DeliveryAddress *Address `json:"deliveryAddress,omitempty"` - // A short description visible on the Pay By Link page. Maximum length: 280 characters. + // A short description visible on the payment page. Maximum length: 280 characters. Description string `json:"description,omitempty"` - // The date that the Pay By Link expires, in ISO 8601 format. For example, 2019-11-23T12:25:28Z. Maximum expiry date should be 30 days from when the payment link is created. If not provided, the default expiry duration is 24 hours. + // The date that the payment link expires, in ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum expiry date should be 30 days from when the payment link is created. If not provided, the default expiry is set to 24 hours after the payment link is created. ExpiresAt string `json:"expiresAt,omitempty"` - // The merchant account identifier, with which you want to process the transaction. + // Price and product information about the purchased items, to be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip. + LineItems *[]LineItem `json:"lineItems,omitempty"` + // The merchant account identifier for which the payment link is created. MerchantAccount string `json:"merchantAccount"` - // The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + // This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle. + MerchantOrderReference string `json:"merchantOrderReference,omitempty"` + // Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\" * Maximum 20 characters per key. When exceeding, the \"178\" error occurs: \"Metadata key size exceeds limit\" * A key cannot have the name `checkout.linkId`. Whatever value is present under that key is going to be replaced by the real link id + Metadata map[string]string `json:"metadata,omitempty"` + // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + RecurringProcessingModel string `json:"recurringProcessingModel,omitempty"` + // A reference that is used to uniquely identify the payment in future communications about the payment status. Reference string `json:"reference"` - // Website URL used for redirection after payment is completed. If provided, a **Continue** button will be shown on the page. If shoppers select the button, they are redirected to the specified URL. + // Website URL used for redirection after payment is completed. If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL. ReturnUrl string `json:"returnUrl,omitempty"` // Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only. Reusable bool `json:"reusable,omitempty"` - // The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require the `shopperEmail` for both `deviceChannel` **browser** and **app**. + RiskData *RiskData `json:"riskData,omitempty"` + // The shopper's email address. ShopperEmail string `json:"shopperEmail,omitempty"` - // The combination of a language code and a country code to specify the language to be used in the payment. + // The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`. For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/checkout/pay-by-link#language-and-localization). ShopperLocale string `json:"shopperLocale,omitempty"` - // The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments. + ShopperName *Name `json:"shopperName,omitempty"` + // A unique identifier for the shopper (for example, user ID or account ID). ShopperReference string `json:"shopperReference,omitempty"` + // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + Splits *[]Split `json:"splits,omitempty"` // The physical store, for which this payment is processed. Store string `json:"store,omitempty"` - // When true and `shopperReference` is provided, the payment details will be stored. + // When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. StorePaymentMethod bool `json:"storePaymentMethod,omitempty"` } diff --git a/src/checkout/model_details_request.go b/src/checkout/model_details_request.go index c3bf5ddbe..0b91d2e98 100644 --- a/src/checkout/model_details_request.go +++ b/src/checkout/model_details_request.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,8 +11,7 @@ package checkout // DetailsRequest struct for DetailsRequest type DetailsRequest struct { - // Use this collection to submit the details that were returned as a result of the `/payments` call. - Details map[string]interface{} `json:"details"` + Details PaymentCompletionDetails `json:"details"` // The `paymentData` value that you received in the response to the `/payments` call. PaymentData string `json:"paymentData,omitempty"` // Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. diff --git a/src/checkout/model_device_render_options.go b/src/checkout/model_device_render_options.go index fefeac7f8..adc6a2d19 100644 --- a/src/checkout/model_device_render_options.go +++ b/src/checkout/model_device_render_options.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,7 +11,7 @@ package checkout // DeviceRenderOptions struct for DeviceRenderOptions type DeviceRenderOptions struct { - // Supported SDK interface types. Allowed values: * Native * Html * both + // Supported SDK interface types. Allowed values: * native * html * both SdkInterface string `json:"sdkInterface,omitempty"` // UI types supported for displaying specific challenges. Allowed values: * text * singleSelect * outOfBand * otherHtml * multiSelect SdkUiType []string `json:"sdkUiType,omitempty"` diff --git a/src/checkout/model_doku_details.go b/src/checkout/model_doku_details.go new file mode 100644 index 000000000..64155f876 --- /dev/null +++ b/src/checkout/model_doku_details.go @@ -0,0 +1,24 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// DokuDetails struct for DokuDetails +type DokuDetails struct { + // The shopper's first name. + FirstName string `json:"firstName"` + Infix string `json:"infix,omitempty"` + // The shopper's last name. + LastName string `json:"lastName"` + OvoId string `json:"ovoId,omitempty"` + // The shopper's email. + ShopperEmail string `json:"shopperEmail"` + // **doku** + Type string `json:"type"` +} diff --git a/src/checkout/model_dotpay_details.go b/src/checkout/model_dotpay_details.go new file mode 100644 index 000000000..b6ff3b1e3 --- /dev/null +++ b/src/checkout/model_dotpay_details.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// DotpayDetails struct for DotpayDetails +type DotpayDetails struct { + // The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it. + Issuer string `json:"issuer"` + // **dotpay** + Type string `json:"type"` +} diff --git a/src/checkout/model_dragonpay_details.go b/src/checkout/model_dragonpay_details.go new file mode 100644 index 000000000..d11d248a5 --- /dev/null +++ b/src/checkout/model_dragonpay_details.go @@ -0,0 +1,20 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// DragonpayDetails struct for DragonpayDetails +type DragonpayDetails struct { + // The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it. + Issuer string `json:"issuer"` + // The shopper’s email address. + ShopperEmail string `json:"shopperEmail,omitempty"` + // **dragonpay** + Type string `json:"type"` +} diff --git a/src/checkout/model_econtext_voucher_details.go b/src/checkout/model_econtext_voucher_details.go new file mode 100644 index 000000000..16463074d --- /dev/null +++ b/src/checkout/model_econtext_voucher_details.go @@ -0,0 +1,24 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// EcontextVoucherDetails struct for EcontextVoucherDetails +type EcontextVoucherDetails struct { + // The shopper's first name. + FirstName string `json:"firstName"` + // The shopper's last name. + LastName string `json:"lastName"` + // The shopper's email. + ShopperEmail string `json:"shopperEmail"` + // The shopper's contact number. + TelephoneNumber string `json:"telephoneNumber"` + // **econtextvoucher** + Type string `json:"type"` +} diff --git a/src/checkout/model_entercash_details.go b/src/checkout/model_entercash_details.go new file mode 100644 index 000000000..6c67bc6a3 --- /dev/null +++ b/src/checkout/model_entercash_details.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// EntercashDetails struct for EntercashDetails +type EntercashDetails struct { + // The issuer id of the shopper's selected bank. + Issuer string `json:"issuer"` + // **entercash** + Type string `json:"type"` +} diff --git a/src/checkout/model_external_platform.go b/src/checkout/model_external_platform.go index b151f2bf3..957de83be 100644 --- a/src/checkout/model_external_platform.go +++ b/src/checkout/model_external_platform.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_forex_quote.go b/src/checkout/model_forex_quote.go index 56debe086..fb70c7f00 100644 --- a/src/checkout/model_forex_quote.go +++ b/src/checkout/model_forex_quote.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_fraud_check_result.go b/src/checkout/model_fraud_check_result.go index 388646919..2d1b549cc 100644 --- a/src/checkout/model_fraud_check_result.go +++ b/src/checkout/model_fraud_check_result.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_fraud_result.go b/src/checkout/model_fraud_result.go index c18979ea3..154929725 100644 --- a/src/checkout/model_fraud_result.go +++ b/src/checkout/model_fraud_result.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_giropay_details.go b/src/checkout/model_giropay_details.go new file mode 100644 index 000000000..f727c6e5f --- /dev/null +++ b/src/checkout/model_giropay_details.go @@ -0,0 +1,20 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// GiropayDetails struct for GiropayDetails +type GiropayDetails struct { + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // **giropay** + Type string `json:"type"` +} diff --git a/src/checkout/model_google_pay_details.go b/src/checkout/model_google_pay_details.go new file mode 100644 index 000000000..5dfbd058e --- /dev/null +++ b/src/checkout/model_google_pay_details.go @@ -0,0 +1,24 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// GooglePayDetails struct for GooglePayDetails +type GooglePayDetails struct { + // The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + FundingSource string `json:"fundingSource,omitempty"` + GooglePayCardNetwork string `json:"googlePayCardNetwork,omitempty"` + GooglePayToken string `json:"googlePayToken"` + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // **paywithgoogle** + Type string `json:"type"` +} diff --git a/src/checkout/model_ideal_details.go b/src/checkout/model_ideal_details.go new file mode 100644 index 000000000..0571118fe --- /dev/null +++ b/src/checkout/model_ideal_details.go @@ -0,0 +1,22 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// IdealDetails struct for IdealDetails +type IdealDetails struct { + // The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it. + Issuer string `json:"issuer"` + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // **ideal** + Type string `json:"type"` +} diff --git a/src/checkout/model_input_detail.go b/src/checkout/model_input_detail.go index ab79a1269..ce845335a 100644 --- a/src/checkout/model_input_detail.go +++ b/src/checkout/model_input_detail.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,7 +12,7 @@ package checkout // InputDetail struct for InputDetail type InputDetail struct { // Configuration parameters for the required input. - Configuration *map[string]interface{} `json:"configuration,omitempty"` + Configuration map[string]string `json:"configuration,omitempty"` // Input details can also be provided recursively. Details *[]SubInputDetail `json:"details,omitempty"` // Input details can also be provided recursively (deprecated). diff --git a/src/checkout/model_installments.go b/src/checkout/model_installments.go index 5a3505793..689856bf9 100644 --- a/src/checkout/model_installments.go +++ b/src/checkout/model_installments.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,6 +11,8 @@ package checkout // Installments struct for Installments type Installments struct { + // Defines the type of installment plan. If not set, defaults to **regular**. Possible values: * **regular** * **revolving** + Plan string `json:"plan,omitempty"` // Defines the number of installments. Its value needs to be greater than zero. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. Value int32 `json:"value"` } diff --git a/src/checkout/model_item.go b/src/checkout/model_item.go index 08ee19977..c28748027 100644 --- a/src/checkout/model_item.go +++ b/src/checkout/model_item.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_klarna_details.go b/src/checkout/model_klarna_details.go new file mode 100644 index 000000000..f00525cec --- /dev/null +++ b/src/checkout/model_klarna_details.go @@ -0,0 +1,26 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// KlarnaDetails struct for KlarnaDetails +type KlarnaDetails struct { + BankAccount string `json:"bankAccount,omitempty"` + BillingAddress string `json:"billingAddress,omitempty"` + DeliveryAddress string `json:"deliveryAddress,omitempty"` + InstallmentConfigurationKey string `json:"installmentConfigurationKey,omitempty"` + PersonalDetails string `json:"personalDetails,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + SeparateDeliveryAddress string `json:"separateDeliveryAddress,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // **klarna** + Type string `json:"type"` +} diff --git a/src/checkout/model_lian_lian_pay_details.go b/src/checkout/model_lian_lian_pay_details.go new file mode 100644 index 000000000..89e956da7 --- /dev/null +++ b/src/checkout/model_lian_lian_pay_details.go @@ -0,0 +1,17 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// LianLianPayDetails struct for LianLianPayDetails +type LianLianPayDetails struct { + TelephoneNumber string `json:"telephoneNumber"` + // **lianlianpay** + Type string `json:"type"` +} diff --git a/src/checkout/model_line_item.go b/src/checkout/model_line_item.go index a100d6198..acca0955d 100644 --- a/src/checkout/model_line_item.go +++ b/src/checkout/model_line_item.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,6 +19,10 @@ type LineItem struct { Description string `json:"description,omitempty"` // ID of the line item. Id string `json:"id,omitempty"` + // Link to the picture of the purchased item. + ImageUrl string `json:"imageUrl,omitempty"` + // Link to the purchased item. + ProductUrl string `json:"productUrl,omitempty"` // Number of items. Quantity int64 `json:"quantity,omitempty"` // Tax amount, in minor units. diff --git a/src/checkout/model_masterpass_details.go b/src/checkout/model_masterpass_details.go new file mode 100644 index 000000000..9492fb838 --- /dev/null +++ b/src/checkout/model_masterpass_details.go @@ -0,0 +1,20 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// MasterpassDetails struct for MasterpassDetails +type MasterpassDetails struct { + // The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + FundingSource string `json:"fundingSource,omitempty"` + // The Masterpass transaction ID. + MasterpassTransactionId string `json:"masterpassTransactionId"` + // **masterpass** + Type string `json:"type"` +} diff --git a/src/checkout/model_mbway_details.go b/src/checkout/model_mbway_details.go new file mode 100644 index 000000000..7c04afa6a --- /dev/null +++ b/src/checkout/model_mbway_details.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// MbwayDetails struct for MbwayDetails +type MbwayDetails struct { + ShopperEmail string `json:"shopperEmail"` + TelephoneNumber string `json:"telephoneNumber"` + // **mbway** + Type string `json:"type"` +} diff --git a/src/checkout/model_merchant_device.go b/src/checkout/model_merchant_device.go index ca4fbeaf1..d05ebea8a 100644 --- a/src/checkout/model_merchant_device.go +++ b/src/checkout/model_merchant_device.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_merchant_risk_indicator.go b/src/checkout/model_merchant_risk_indicator.go index d55303951..f05cb8262 100644 --- a/src/checkout/model_merchant_risk_indicator.go +++ b/src/checkout/model_merchant_risk_indicator.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -23,7 +23,7 @@ type MerchantRiskIndicator struct { // The estimated delivery time for the shopper to receive the goods. Allowed values: * `electronicDelivery` * `sameDayShipping` * `overnightShipping` * `twoOrMoreDaysShipping` DeliveryTimeframe string `json:"deliveryTimeframe,omitempty"` GiftCardAmount *Amount `json:"giftCardAmount,omitempty"` - // Number of individual prepaid or gift cards used for this purchase. + // For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. GiftCardCount int32 `json:"giftCardCount,omitempty"` // For pre-order purchases, the expected date this product will be available to the shopper. PreOrderDate *time.Time `json:"preOrderDate,omitempty"` diff --git a/src/checkout/model_mobile_pay_details.go b/src/checkout/model_mobile_pay_details.go new file mode 100644 index 000000000..a050085b2 --- /dev/null +++ b/src/checkout/model_mobile_pay_details.go @@ -0,0 +1,16 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// MobilePayDetails struct for MobilePayDetails +type MobilePayDetails struct { + // **mobilepay** + Type string `json:"type"` +} diff --git a/src/checkout/model_mol_pay_details.go b/src/checkout/model_mol_pay_details.go new file mode 100644 index 000000000..d8ee4293d --- /dev/null +++ b/src/checkout/model_mol_pay_details.go @@ -0,0 +1,17 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// MolPayDetails struct for MolPayDetails +type MolPayDetails struct { + Issuer string `json:"issuer"` + // **molpay** + Type string `json:"type"` +} diff --git a/src/checkout/model_name.go b/src/checkout/model_name.go index ea1b49e27..1418c9d45 100644 --- a/src/checkout/model_name.go +++ b/src/checkout/model_name.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_open_invoice_details.go b/src/checkout/model_open_invoice_details.go new file mode 100644 index 000000000..010bc59fd --- /dev/null +++ b/src/checkout/model_open_invoice_details.go @@ -0,0 +1,26 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// OpenInvoiceDetails struct for OpenInvoiceDetails +type OpenInvoiceDetails struct { + BankAccount string `json:"bankAccount,omitempty"` + BillingAddress string `json:"billingAddress,omitempty"` + DeliveryAddress string `json:"deliveryAddress,omitempty"` + InstallmentConfigurationKey string `json:"installmentConfigurationKey,omitempty"` + PersonalDetails string `json:"personalDetails,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + SeparateDeliveryAddress string `json:"separateDeliveryAddress,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // **openinvoice** + Type string `json:"type"` +} diff --git a/src/checkout/model_pay_pal_details.go b/src/checkout/model_pay_pal_details.go new file mode 100644 index 000000000..46d7cd345 --- /dev/null +++ b/src/checkout/model_pay_pal_details.go @@ -0,0 +1,24 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// PayPalDetails struct for PayPalDetails +type PayPalDetails struct { + OrderID string `json:"orderID,omitempty"` + PayerID string `json:"payerID,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // The type of flow to initiate. + Subtype string `json:"subtype,omitempty"` + // **paypal** + Type string `json:"type"` +} diff --git a/src/checkout/model_pay_u_upi_details.go b/src/checkout/model_pay_u_upi_details.go new file mode 100644 index 000000000..e5b73fb13 --- /dev/null +++ b/src/checkout/model_pay_u_upi_details.go @@ -0,0 +1,25 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// PayUUpiDetails struct for PayUUpiDetails +type PayUUpiDetails struct { + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. + ShopperNotificationReference string `json:"shopperNotificationReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + SubscriptionDetails *SubscriptionDetails `json:"subscriptionDetails,omitempty"` + // **payu_IN_upi** + Type string `json:"type"` + // The virtual payment address for UPI. + VirtualPaymentAddress string `json:"virtualPaymentAddress,omitempty"` +} diff --git a/src/checkout/model_payment_completion_details.go b/src/checkout/model_payment_completion_details.go new file mode 100644 index 000000000..c60f920f0 --- /dev/null +++ b/src/checkout/model_payment_completion_details.go @@ -0,0 +1,44 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// PaymentCompletionDetails struct for PaymentCompletionDetails +type PaymentCompletionDetails struct { + // A payment session identifier returned by the card issuer. + MD string `json:"MD,omitempty"` + // (3D) Payment Authentication Request data for the card issuer. + PaReq string `json:"PaReq,omitempty"` + // (3D) Payment Authentication Response data by the card issuer. + PaRes string `json:"PaRes,omitempty"` + // PayPal-generated token for recurring payments. + BillingToken string `json:"billingToken,omitempty"` + // The SMS verification code collected from the shopper. + CupsecureplusSmscode string `json:"cupsecureplus.smscode,omitempty"` + // PayPal-generated third party access token. + FacilitatorAccessToken string `json:"facilitatorAccessToken,omitempty"` + // A random number sent to the mobile phone number of the shopper to verify the payment. + OneTimePasscode string `json:"oneTimePasscode,omitempty"` + // PayPal-assigned ID for the order. + OrderID string `json:"orderID,omitempty"` + // PayPal-assigned ID for the payer (shopper). + PayerID string `json:"payerID,omitempty"` + // Payload appended to the `returnURL` as a result of the redirect. + Payload string `json:"payload,omitempty"` + // PayPal-generated ID for the payment. + PaymentID string `json:"paymentID,omitempty"` + // Value passed from the WeChat MiniProgram `wx.requestPayment` **complete** callback. Possible values: any value starting with `requestPayment:`. + PaymentStatus string `json:"paymentStatus,omitempty"` + // The result of the redirect as appended to the `returnURL`. + RedirectResult string `json:"redirectResult,omitempty"` + // Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`. + Threeds2ChallengeResult string `json:"threeds2.challengeResult,omitempty"` + // Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`. + Threeds2Fingerprint string `json:"threeds2.fingerprint,omitempty"` +} diff --git a/src/checkout/model_payment_details.go b/src/checkout/model_payment_details.go new file mode 100644 index 000000000..2f28324a7 --- /dev/null +++ b/src/checkout/model_payment_details.go @@ -0,0 +1,16 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// PaymentDetails struct for PaymentDetails +type PaymentDetails struct { + // The payment method type. + Type string `json:"type"` +} diff --git a/src/checkout/model_payment_link_resource.go b/src/checkout/model_payment_link_resource.go new file mode 100644 index 000000000..38e2525a3 --- /dev/null +++ b/src/checkout/model_payment_link_resource.go @@ -0,0 +1,67 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +import ( + "time" +) +// PaymentLinkResource struct for PaymentLinkResource +type PaymentLinkResource struct { + // List of payments methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` + AllowedPaymentMethods []string `json:"allowedPaymentMethods,omitempty"` + Amount Amount `json:"amount"` + ApplicationInfo *ApplicationInfo `json:"applicationInfo,omitempty"` + BillingAddress *Address `json:"billingAddress,omitempty"` + // List of payments methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]` + BlockedPaymentMethods []string `json:"blockedPaymentMethods,omitempty"` + // The shopper's two-letter country code. + CountryCode string `json:"countryCode,omitempty"` + // The date and time the purchased goods should be delivered. In ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. + DeliverAt *time.Time `json:"deliverAt,omitempty"` + DeliveryAddress *Address `json:"deliveryAddress,omitempty"` + // A short description visible on the payment page. Maximum length: 280 characters. + Description string `json:"description,omitempty"` + // The date that the payment link expires, in ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum expiry date should be 30 days from when the payment link is created. If not provided, the default expiry is set to 24 hours after the payment link is created. + ExpiresAt string `json:"expiresAt,omitempty"` + // A unique identifier of the payment link. + Id string `json:"id"` + // Price and product information about the purchased items, to be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip. + LineItems *[]LineItem `json:"lineItems,omitempty"` + // The merchant account identifier for which the payment link is created. + MerchantAccount string `json:"merchantAccount"` + // This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle. + MerchantOrderReference string `json:"merchantOrderReference,omitempty"` + // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + RecurringProcessingModel string `json:"recurringProcessingModel,omitempty"` + // A reference that is used to uniquely identify the payment in future communications about the payment status. + Reference string `json:"reference"` + // Website URL used for redirection after payment is completed. If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL. + ReturnUrl string `json:"returnUrl,omitempty"` + // Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only. + Reusable bool `json:"reusable,omitempty"` + RiskData *RiskData `json:"riskData,omitempty"` + // The shopper's email address. + ShopperEmail string `json:"shopperEmail,omitempty"` + // The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`. For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/checkout/pay-by-link#language-and-localization). + ShopperLocale string `json:"shopperLocale,omitempty"` + ShopperName *Name `json:"shopperName,omitempty"` + // A unique identifier for the shopper (for example, user ID or account ID). + ShopperReference string `json:"shopperReference,omitempty"` + // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + Splits *[]Split `json:"splits,omitempty"` + // Status of the payment link. Possible values: * **active** * **completed** * **expired** + Status string `json:"status"` + // The physical store, for which this payment is processed. + Store string `json:"store,omitempty"` + // When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. + StorePaymentMethod bool `json:"storePaymentMethod,omitempty"` + // The URL at which the shopper can complete the payment. + Url string `json:"url"` +} diff --git a/src/checkout/model_payment_method.go b/src/checkout/model_payment_method.go index 8cd989eec..228d90418 100644 --- a/src/checkout/model_payment_method.go +++ b/src/checkout/model_payment_method.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,21 +11,21 @@ package checkout // PaymentMethod struct for PaymentMethod type PaymentMethod struct { + // Brand for the selected gift card. For example: plastix, hmclub. + Brand string `json:"brand,omitempty"` // List of possible brands. For example: visa, mc. Brands []string `json:"brands,omitempty"` // The configuration of the payment method. - Configuration *map[string]interface{} `json:"configuration,omitempty"` + Configuration map[string]string `json:"configuration,omitempty"` // All input details to be provided to complete the payment with this payment method. Details *[]InputDetail `json:"details,omitempty"` + // The funding source of the payment method. + FundingSource string `json:"fundingSource,omitempty"` Group *PaymentMethodGroup `json:"group,omitempty"` // All input details to be provided to complete the payment with this payment method. InputDetails *[]InputDetail `json:"inputDetails,omitempty"` // The displayable name of this payment method. Name string `json:"name,omitempty"` - // Echo data required to send in next calls. - PaymentMethodData string `json:"paymentMethodData,omitempty"` - // Indicates whether this payment method supports tokenization or not. - SupportsRecurring bool `json:"supportsRecurring,omitempty"` // The unique payment method code. Type string `json:"type,omitempty"` } diff --git a/src/checkout/model_payment_method_group.go b/src/checkout/model_payment_method_group.go index 2e1fba25f..ba30d4108 100644 --- a/src/checkout/model_payment_method_group.go +++ b/src/checkout/model_payment_method_group.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_payment_methods_request.go b/src/checkout/model_payment_methods_request.go index cc15b6b11..70c50d22d 100644 --- a/src/checkout/model_payment_methods_request.go +++ b/src/checkout/model_payment_methods_request.go @@ -1,18 +1,19 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package checkout + // PaymentMethodsRequest struct for PaymentMethodsRequest type PaymentMethodsRequest struct { // This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. - AdditionalData interface{} `json:"additionalData,omitempty"` + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` // List of payments methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` AllowedPaymentMethods []string `json:"allowedPaymentMethods,omitempty"` Amount *Amount `json:"amount,omitempty"` @@ -22,16 +23,15 @@ type PaymentMethodsRequest struct { Channel string `json:"channel,omitempty"` // The shopper's country code. CountryCode string `json:"countryCode,omitempty"` - // Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. - EnableRealTimeUpdate bool `json:"enableRealTimeUpdate,omitempty"` // The merchant account identifier, with which you want to process the transaction. MerchantAccount string `json:"merchantAccount"` + Order *CheckoutOrder `json:"order,omitempty"` // The combination of a language code and a country code to specify the language to be used in the payment. ShopperLocale string `json:"shopperLocale,omitempty"` - // The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments. + // Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. ShopperReference string `json:"shopperReference,omitempty"` + // Boolean value indicating whether the card payment method should be split into separate debit and credit options. + SplitCardFundingSources bool `json:"splitCardFundingSources,omitempty"` // The physical store, for which this payment is processed. Store string `json:"store,omitempty"` - // If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. - ThreeDSAuthenticationOnly bool `json:"threeDSAuthenticationOnly,omitempty"` } diff --git a/src/checkout/model_payment_methods_response.go b/src/checkout/model_payment_methods_response.go index 2bb460528..336d55a57 100644 --- a/src/checkout/model_payment_methods_response.go +++ b/src/checkout/model_payment_methods_response.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,10 +11,6 @@ package checkout // PaymentMethodsResponse struct for PaymentMethodsResponse type PaymentMethodsResponse struct { - // Groups of payment methods. - Groups *[]PaymentMethodsGroup `json:"groups,omitempty"` - // Detailed list of one-click payment methods. - OneClickPaymentMethods *[]RecurringDetail `json:"oneClickPaymentMethods,omitempty"` // Detailed list of payment methods required to generate payment forms. PaymentMethods *[]PaymentMethod `json:"paymentMethods,omitempty"` // List of all stored payment methods. diff --git a/src/checkout/model_payment_request.go b/src/checkout/model_payment_request.go index 2e5183837..780d0006d 100644 --- a/src/checkout/model_payment_request.go +++ b/src/checkout/model_payment_request.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -44,8 +44,6 @@ type PaymentRequest struct { EnableOneClick bool `json:"enableOneClick,omitempty"` // When true and `shopperReference` is provided, the payment details will be tokenized for payouts. EnablePayOut bool `json:"enablePayOut,omitempty"` - // Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. - EnableRealTimeUpdate bool `json:"enableRealTimeUpdate,omitempty"` // When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. EnableRecurring bool `json:"enableRecurring,omitempty"` // The type of the entity the payment is processed for. @@ -53,7 +51,7 @@ type PaymentRequest struct { // An integer value that is added to the normal fraud score. The value can be either positive or negative. FraudOffset int32 `json:"fraudOffset,omitempty"` Installments *Installments `json:"installments,omitempty"` - // Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for Klarna, AfterPay, and RatePay. + // Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for Klarna, AfterPay, 3x 4x Oney, Zip and RatePay. LineItems *[]LineItem `json:"lineItems,omitempty"` // The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. Mcc string `json:"mcc,omitempty"` @@ -63,19 +61,20 @@ type PaymentRequest struct { MerchantOrderReference string `json:"merchantOrderReference,omitempty"` MerchantRiskIndicator *MerchantRiskIndicator `json:"merchantRiskIndicator,omitempty"` // Metadata consists of entries, each of which includes a key and a value. Limitations: Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". - Metadata *map[string]interface{} `json:"metadata,omitempty"` - MpiData *ThreeDSecureData `json:"mpiData,omitempty"` + Metadata map[string]string `json:"metadata,omitempty"` + MpiData *ThreeDSecureData `json:"mpiData,omitempty"` + Order *CheckoutOrder `json:"order,omitempty"` // When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. OrderReference string `json:"orderReference,omitempty"` // Required for the 3D Secure 2 `channel` **Web** integration. Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from. Origin string `json:"origin,omitempty"` - // The collection that contains the type of the payment method and its specific information (e.g. `idealIssuer`). + // The type and required details of a payment method to use. PaymentMethod map[string]interface{} `json:"paymentMethod"` // Date after which no further authorisations shall be performed. Only for 3D Secure 2. RecurringExpiry string `json:"recurringExpiry,omitempty"` // Minimum number of days between authorisations. Only for 3D Secure 2. RecurringFrequency string `json:"recurringFrequency,omitempty"` - // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – Card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – A transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. RecurringProcessingModel string `json:"recurringProcessingModel,omitempty"` // Specifies the redirect method (GET or POST) when redirecting back from the issuer. RedirectFromIssuerMethod string `json:"redirectFromIssuerMethod,omitempty"` @@ -86,7 +85,7 @@ type PaymentRequest struct { // The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name` ReturnUrl string `json:"returnUrl"` RiskData *RiskData `json:"riskData,omitempty"` - // The maximum validity of the session. + // The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00 SessionValidity string `json:"sessionValidity,omitempty"` // The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require the `shopperEmail` for both `deviceChannel` **browser** and **app**. ShopperEmail string `json:"shopperEmail,omitempty"` @@ -97,18 +96,18 @@ type PaymentRequest struct { // The combination of a language code and a country code to specify the language to be used in the payment. ShopperLocale string `json:"shopperLocale,omitempty"` ShopperName *Name `json:"shopperName,omitempty"` - // The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments. + // Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. ShopperReference string `json:"shopperReference,omitempty"` - // The text to appear on the shopper's bank statement. + // The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. ShopperStatement string `json:"shopperStatement,omitempty"` // The shopper's social security number. SocialSecurityNumber string `json:"socialSecurityNumber,omitempty"` - // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). + // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). Splits *[]Split `json:"splits,omitempty"` - // When true and `shopperReference` is provided, the payment details will be stored. - StorePaymentMethod bool `json:"storePaymentMethod,omitempty"` // The physical store, for which this payment is processed. Store string `json:"store,omitempty"` + // When true and `shopperReference` is provided, the payment details will be stored. + StorePaymentMethod bool `json:"storePaymentMethod,omitempty"` // The shopper's telephone number. TelephoneNumber string `json:"telephoneNumber,omitempty"` ThreeDS2RequestData *ThreeDS2RequestData `json:"threeDS2RequestData,omitempty"` diff --git a/src/checkout/model_payment_request_payment_method_one_of.go b/src/checkout/model_payment_request_payment_method_one_of.go new file mode 100644 index 000000000..d63b7d7ae --- /dev/null +++ b/src/checkout/model_payment_request_payment_method_one_of.go @@ -0,0 +1,16 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout + +// PaymentRequestPaymentMethodOneOf struct for PaymentRequestPaymentMethodOneOf +type PaymentRequestPaymentMethodOneOf struct { + PaymentRequestPaymentMethodOneOfInterface interface { } +} diff --git a/src/checkout/model_payment_response.go b/src/checkout/model_payment_response.go index c87e5b28d..5685f2025 100644 --- a/src/checkout/model_payment_response.go +++ b/src/checkout/model_payment_response.go @@ -1,43 +1,43 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package checkout -import ( - "github.com/adyen/adyen-go-api-library/v3/src/common" -) +import "github.com/adyen/adyen-go-api-library/v4/src/common" // PaymentResponse struct for PaymentResponse type PaymentResponse struct { - Action *CheckoutPaymentsAction `json:"action,omitempty"` + // Action to be taken for completing the payment. + Action *PaymentResponseActionOneOf `json:"action,omitempty"` // This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**. AdditionalData interface{} `json:"additionalData,omitempty"` Amount *Amount `json:"amount,omitempty"` // Contains `threeds2.fingerprint` or `threeds2.challengeToken` values to be used in further calls to `/payments/details` endpoint. - Authentication *map[string]interface{} `json:"authentication,omitempty"` + Authentication map[string]string `json:"authentication,omitempty"` // When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint. Details *[]InputDetail `json:"details,omitempty"` FraudResult *FraudResult `json:"fraudResult,omitempty"` // The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. - MerchantReference string `json:"merchantReference,omitempty"` + MerchantReference string `json:"merchantReference,omitempty"` + Order *CheckoutOrderResponse `json:"order,omitempty"` // Contains the details that will be presented to the shopper. - OutputDetails *map[string]interface{} `json:"outputDetails,omitempty"` + OutputDetails map[string]string `json:"outputDetails,omitempty"` // When non-empty, contains a value that you must submit to the `/payments/details` endpoint. PaymentData string `json:"paymentData,omitempty"` // Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > `pspReference` is returned only for non-redirect payment methods. PspReference string `json:"pspReference,omitempty"` Redirect *Redirect `json:"redirect,omitempty"` - // If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + // If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). RefusalReason string `json:"refusalReason,omitempty"` // Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). RefusalReasonCode string `json:"refusalReasonCode,omitempty"` - // The result of the payment. Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. For more information, refer to [Result codes](https://docs.adyen.com/checkout/payment-result-codes). * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + // The result of the payment. For more information, see [Result codes](https://docs.adyen.com/checkout/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. ResultCode common.ResultCode `json:"resultCode,omitempty"` } diff --git a/src/checkout/model_payment_response_action_one_of.go b/src/checkout/model_payment_response_action_one_of.go new file mode 100644 index 000000000..e50c5dedb --- /dev/null +++ b/src/checkout/model_payment_response_action_one_of.go @@ -0,0 +1,16 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout + +// PaymentResponseActionOneOf struct for PaymentResponseActionOneOf +type PaymentResponseActionOneOf struct { + PaymentResponseActionOneOfInterface interface { } +} diff --git a/src/checkout/model_payment_setup_request.go b/src/checkout/model_payment_setup_request.go index 6e972998a..207163141 100644 --- a/src/checkout/model_payment_setup_request.go +++ b/src/checkout/model_payment_setup_request.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,44 +17,42 @@ import ( // PaymentSetupRequest struct for PaymentSetupRequest type PaymentSetupRequest struct { // This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. - AdditionalData interface{} `json:"additionalData,omitempty"` - // List of payments methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` - AllowedPaymentMethods []string `json:"allowedPaymentMethods,omitempty"` - Amount Amount `json:"amount"` - ApplicationInfo *ApplicationInfo `json:"applicationInfo,omitempty"` - BillingAddress *Address `json:"billingAddress,omitempty"` - // List of payments methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]` + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` + // List of payments methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` + AllowedPaymentMethods []string `json:"allowedPaymentMethods,omitempty"` + Amount Amount `json:"amount"` + ApplicationInfo *ApplicationInfo `json:"applicationInfo,omitempty"` + BillingAddress *Address `json:"billingAddress,omitempty"` + // List of payments methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]` BlockedPaymentMethods []string `json:"blockedPaymentMethods,omitempty"` // The delay between the authorisation and scheduled auto-capture, specified in hours. CaptureDelayHours int32 `json:"captureDelayHours,omitempty"` // The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * iOS * Android * Web - Channel string `json:"channel,omitempty"` - Company *Company `json:"company,omitempty"` + Channel string `json:"channel,omitempty"` + Company *Company `json:"company,omitempty"` Configuration *Configuration `json:"configuration,omitempty"` // Conversion ID that corresponds to the Id generated for tracking user payment journey. ConversionId string `json:"conversionId,omitempty"` // The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE CountryCode string `json:"countryCode"` // The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD - DateOfBirth *time.Time `json:"dateOfBirth,omitempty"` - DccQuote *ForexQuote `json:"dccQuote,omitempty"` - DeliveryAddress *Address `json:"deliveryAddress,omitempty"` + DateOfBirth *time.Time `json:"dateOfBirth,omitempty"` + DccQuote *ForexQuote `json:"dccQuote,omitempty"` + DeliveryAddress *Address `json:"deliveryAddress,omitempty"` // The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 DeliveryDate *time.Time `json:"deliveryDate,omitempty"` // When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments. EnableOneClick bool `json:"enableOneClick,omitempty"` // When true and `shopperReference` is provided, the payment details will be tokenized for payouts. EnablePayOut bool `json:"enablePayOut,omitempty"` - // Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. - EnableRealTimeUpdate bool `json:"enableRealTimeUpdate,omitempty"` // When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. EnableRecurring bool `json:"enableRecurring,omitempty"` // The type of the entity the payment is processed for. EntityType string `json:"entityType,omitempty"` // An integer value that is added to the normal fraud score. The value can be either positive or negative. - FraudOffset int32 `json:"fraudOffset,omitempty"` + FraudOffset int32 `json:"fraudOffset,omitempty"` Installments *Installments `json:"installments,omitempty"` - // Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for Klarna, AfterPay, and RatePay. + // Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for Klarna, AfterPay, 3x 4x Oney, Zip and RatePay. LineItems *[]LineItem `json:"lineItems,omitempty"` // The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. Mcc string `json:"mcc,omitempty"` @@ -63,7 +61,7 @@ type PaymentSetupRequest struct { // This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. MerchantOrderReference string `json:"merchantOrderReference,omitempty"` // Metadata consists of entries, each of which includes a key and a value. Limitations: Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". - Metadata *map[string]interface{} `json:"metadata,omitempty"` + Metadata map[string]string `json:"metadata,omitempty"` // When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. OrderReference string `json:"orderReference,omitempty"` // Required for the Web integration. Set this parameter to the origin URL of the page that you are loading the SDK from. @@ -75,11 +73,11 @@ type PaymentSetupRequest struct { // The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. Reference string `json:"reference"` // The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name` - ReturnUrl string `json:"returnUrl"` - RiskData *RiskData `json:"riskData,omitempty"` + ReturnUrl string `json:"returnUrl"` + RiskData *RiskData `json:"riskData,omitempty"` // The version of the SDK you are using (for Web SDK integrations only). SdkVersion string `json:"sdkVersion,omitempty"` - // The maximum validity of the session. + // The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00 SessionValidity string `json:"sessionValidity,omitempty"` // The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require the `shopperEmail` for both `deviceChannel` **browser** and **app**. ShopperEmail string `json:"shopperEmail,omitempty"` @@ -89,14 +87,14 @@ type PaymentSetupRequest struct { ShopperInteraction string `json:"shopperInteraction,omitempty"` // The combination of a language code and a country code to specify the language to be used in the payment. ShopperLocale string `json:"shopperLocale,omitempty"` - ShopperName *Name `json:"shopperName,omitempty"` - // The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments. + ShopperName *Name `json:"shopperName,omitempty"` + // Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. ShopperReference string `json:"shopperReference,omitempty"` - // The text to appear on the shopper's bank statement. + // The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. ShopperStatement string `json:"shopperStatement,omitempty"` // The shopper's social security number. SocialSecurityNumber string `json:"socialSecurityNumber,omitempty"` - // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). + // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). Splits *[]Split `json:"splits,omitempty"` // When true and `shopperReference` is provided, the payment details will be stored. StorePaymentMethod bool `json:"storePaymentMethod,omitempty"` diff --git a/src/checkout/model_payment_setup_response.go b/src/checkout/model_payment_setup_response.go index 54c30d472..a7caa3e1b 100644 --- a/src/checkout/model_payment_setup_response.go +++ b/src/checkout/model_payment_setup_response.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_payment_verification_request.go b/src/checkout/model_payment_verification_request.go index 8eee5e0fb..66831b96c 100644 --- a/src/checkout/model_payment_verification_request.go +++ b/src/checkout/model_payment_verification_request.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_payment_verification_response.go b/src/checkout/model_payment_verification_response.go index 6679cf35b..3d8be71f2 100644 --- a/src/checkout/model_payment_verification_response.go +++ b/src/checkout/model_payment_verification_response.go @@ -1,35 +1,34 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package checkout -import "github.com/adyen/adyen-go-api-library/v3/src/common" - // PaymentVerificationResponse struct for PaymentVerificationResponse type PaymentVerificationResponse struct { // This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**. - AdditionalData interface{} `json:"additionalData,omitempty"` - FraudResult *FraudResult `json:"fraudResult,omitempty"` + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` + FraudResult *FraudResult `json:"fraudResult,omitempty"` // A unique value that you provided in the initial `/paymentSession` request as a `reference` field. MerchantReference string `json:"merchantReference"` + Order *CheckoutOrderResponse `json:"order,omitempty"` // The payment method used in the transaction. PaymentMethod string `json:"paymentMethod"` // Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > `pspReference` is returned only for non-redirect payment methods. PspReference string `json:"pspReference,omitempty"` - // If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + // If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). RefusalReason string `json:"refusalReason,omitempty"` // Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). RefusalReasonCode string `json:"refusalReasonCode,omitempty"` - // The result of the payment. Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. For more information, refer to [Result codes](https://docs.adyen.com/checkout/payment-result-codes). * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. - ResultCode common.ResultCode `json:"resultCode,omitempty"` - ServiceError *ServiceError `json:"serviceError,omitempty"` + // The result of the payment. For more information, see [Result codes](https://docs.adyen.com/checkout/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + ResultCode string `json:"resultCode,omitempty"` + ServiceError *ServiceError `json:"serviceError,omitempty"` // The shopperLocale value provided in the payment request. ShopperLocale string `json:"shopperLocale"` } diff --git a/src/checkout/model_qiwi_wallet_details.go b/src/checkout/model_qiwi_wallet_details.go new file mode 100644 index 000000000..f927b4448 --- /dev/null +++ b/src/checkout/model_qiwi_wallet_details.go @@ -0,0 +1,17 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// QiwiWalletDetails struct for QiwiWalletDetails +type QiwiWalletDetails struct { + TelephoneNumber string `json:"telephoneNumber"` + // **qiwiwallet** + Type string `json:"type"` +} diff --git a/src/checkout/model_recurring.go b/src/checkout/model_recurring.go index 3925598ac..5021d3a69 100644 --- a/src/checkout/model_recurring.go +++ b/src/checkout/model_recurring.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_recurring_detail.go b/src/checkout/model_recurring_detail.go index d2bd39aaa..750b9c4ce 100644 --- a/src/checkout/model_recurring_detail.go +++ b/src/checkout/model_recurring_detail.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,24 +11,24 @@ package checkout // RecurringDetail struct for RecurringDetail type RecurringDetail struct { + // Brand for the selected gift card. For example: plastix, hmclub. + Brand string `json:"brand,omitempty"` // List of possible brands. For example: visa, mc. Brands []string `json:"brands,omitempty"` // The configuration of the payment method. - Configuration *map[string]interface{} `json:"configuration,omitempty"` + Configuration map[string]string `json:"configuration,omitempty"` // All input details to be provided to complete the payment with this payment method. Details *[]InputDetail `json:"details,omitempty"` + // The funding source of the payment method. + FundingSource string `json:"fundingSource,omitempty"` Group *PaymentMethodGroup `json:"group,omitempty"` // All input details to be provided to complete the payment with this payment method. InputDetails *[]InputDetail `json:"inputDetails,omitempty"` // The displayable name of this payment method. Name string `json:"name,omitempty"` - // Echo data required to send in next calls. - PaymentMethodData string `json:"paymentMethodData,omitempty"` // The reference that uniquely identifies the recurring detail. RecurringDetailReference string `json:"recurringDetailReference,omitempty"` StoredDetails *StoredDetails `json:"storedDetails,omitempty"` - // Indicates whether this payment method supports tokenization or not. - SupportsRecurring bool `json:"supportsRecurring,omitempty"` // The unique payment method code. Type string `json:"type,omitempty"` } diff --git a/src/checkout/model_redirect.go b/src/checkout/model_redirect.go index 73e82ec3a..9f01c36a3 100644 --- a/src/checkout/model_redirect.go +++ b/src/checkout/model_redirect.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,7 +12,7 @@ package checkout // Redirect struct for Redirect type Redirect struct { // When the redirect URL must be accessed via POST, use this data to post to the redirect URL. - Data *map[string]interface{} `json:"data,omitempty"` + Data map[string]string `json:"data,omitempty"` // The web method that you must use to access the redirect URL. Possible values: GET, POST. Method string `json:"method,omitempty"` // The URL, to which you must redirect a shopper to complete a payment. diff --git a/src/checkout/model_response_additional_data3_d_secure.go b/src/checkout/model_response_additional_data3_d_secure.go new file mode 100644 index 000000000..e6c1af1d0 --- /dev/null +++ b/src/checkout/model_response_additional_data3_d_secure.go @@ -0,0 +1,16 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// ResponseAdditionalData3DSecure struct for ResponseAdditionalData3DSecure +type ResponseAdditionalData3DSecure struct { + // Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** + ScaExemptionRequested string `json:"scaExemptionRequested,omitempty"` +} diff --git a/src/checkout/model_response_additional_data_billing_address.go b/src/checkout/model_response_additional_data_billing_address.go index 8c17f091a..c53c3337c 100644 --- a/src/checkout/model_response_additional_data_billing_address.go +++ b/src/checkout/model_response_additional_data_billing_address.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_response_additional_data_card.go b/src/checkout/model_response_additional_data_card.go index ebab28fae..3fefeff3d 100644 --- a/src/checkout/model_response_additional_data_card.go +++ b/src/checkout/model_response_additional_data_card.go @@ -1,15 +1,14 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package checkout - // ResponseAdditionalDataCard struct for ResponseAdditionalDataCard type ResponseAdditionalDataCard struct { // The Bank Identification Number of a credit card, which is the first six digits of a card number. Example: 521234 @@ -24,6 +23,6 @@ type ResponseAdditionalDataCard struct { CardIssuingCurrency string `json:"cardIssuingCurrency,omitempty"` // The card payment method used for the transaction. Example: amex CardPaymentMethod string `json:"cardPaymentMethod,omitempty"` - // The last four digits of a card number. > Returned only in case of a card payment. + // The last four digits of a card number. > Returned only in case of a card payment. CardSummary string `json:"cardSummary,omitempty"` } diff --git a/src/checkout/model_response_additional_data_common.go b/src/checkout/model_response_additional_data_common.go index ead8f588d..63d21b592 100644 --- a/src/checkout/model_response_additional_data_common.go +++ b/src/checkout/model_response_additional_data_common.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,7 +11,7 @@ package checkout // ResponseAdditionalDataCommon struct for ResponseAdditionalDataCommon type ResponseAdditionalDataCommon struct { - // The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions. + // The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions. AcquirerAccountCode string `json:"acquirerAccountCode,omitempty"` // The name of the acquirer processing the payment request. Example: TestPmmAcquirer AcquirerCode string `json:"acquirerCode,omitempty"` @@ -31,13 +31,13 @@ type ResponseAdditionalDataCommon struct { AvsResult string `json:"avsResult,omitempty"` // Raw AVS result received from the acquirer, where available. Example: D AvsResultRaw string `json:"avsResultRaw,omitempty"` - // BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions. + // BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions. Bic string `json:"bic,omitempty"` // Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction. DsTransID string `json:"dsTransID,omitempty"` // The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02 Eci string `json:"eci,omitempty"` - // The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment. + // The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment. ExpiryDate string `json:"expiryDate,omitempty"` // The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR ExtraCostsCurrency string `json:"extraCostsCurrency,omitempty"` @@ -45,15 +45,15 @@ type ResponseAdditionalDataCommon struct { ExtraCostsValue string `json:"extraCostsValue,omitempty"` // The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair. FraudCheckItemNrFraudCheckname string `json:"fraudCheck-[itemNr]-[FraudCheckname],omitempty"` - // Information regarding the funding type of the card. The possible return values are: * CHARGE * CREDIT * DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE * DEFFERED_DEBIT > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. + // Information regarding the funding type of the card. The possible return values are: * CHARGE * CREDIT * DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE * DEFFERED_DEBIT > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. FundingSource string `json:"fundingSource,omitempty"` // Indicates availability of funds. Visa: * \"I\" (fast funds are supported) * \"N\" (otherwise) Mastercard: * \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) * \"N\" (otherwise) > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\". FundsAvailability string `json:"fundsAvailability,omitempty"` - // Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\". Possible values: * 3D Secure Mandated * Closed Account * ContAuth Not Supported * CVC Mandated * Ecommerce Not Allowed * Crossborder Not Supported * Card Updated * Low Authrate Bin * Non-reloadable prepaid card + // Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\". Possible values: * 3D Secure Mandated * Closed Account * ContAuth Not Supported * CVC Mandated * Ecommerce Not Allowed * Crossborder Not Supported * Card Updated * Low Authrate Bin * Non-reloadable prepaid card InferredRefusalReason string `json:"inferredRefusalReason,omitempty"` // The issuing country of the card based on the BIN list that Adyen maintains. Example: JP IssuerCountry string `json:"issuerCountry,omitempty"` - // The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field. + // The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field. McBankNetReferenceNumber string `json:"mcBankNetReferenceNumber,omitempty"` // Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID. NetworkTxReference string `json:"networkTxReference,omitempty"` @@ -63,9 +63,9 @@ type ResponseAdditionalDataCommon struct { PaymentAccountReference string `json:"paymentAccountReference,omitempty"` // The Adyen sub-variant of the payment method used for the payment request. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). Example: mcpro PaymentMethodVariant string `json:"paymentMethodVariant,omitempty"` - // Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown) + // Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown) PayoutEligible string `json:"payoutEligible,omitempty"` - // The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder + // The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder RealtimeAccountUpdaterStatus string `json:"realtimeAccountUpdaterStatus,omitempty"` // Message to be displayed on the terminal. ReceiptFreeText string `json:"receiptFreeText,omitempty"` @@ -93,7 +93,7 @@ type ResponseAdditionalDataCommon struct { ThreeDOfferedResponse string `json:"threeDOfferedResponse,omitempty"` // The 3D Secure 2 version. ThreeDSVersion string `json:"threeDSVersion,omitempty"` - // The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field. + // The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field. VisaTransactionId string `json:"visaTransactionId,omitempty"` // The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. Example: ODgxNDc2MDg2MDExODk5MAAAAAA= Xid string `json:"xid,omitempty"` diff --git a/src/checkout/model_response_additional_data_delivery_address.go b/src/checkout/model_response_additional_data_delivery_address.go index a859fc3b4..8a9d0bd25 100644 --- a/src/checkout/model_response_additional_data_delivery_address.go +++ b/src/checkout/model_response_additional_data_delivery_address.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_response_additional_data_installments.go b/src/checkout/model_response_additional_data_installments.go index 04d1e5d8b..6b42a2e8d 100644 --- a/src/checkout/model_response_additional_data_installments.go +++ b/src/checkout/model_response_additional_data_installments.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,28 +11,28 @@ package checkout // ResponseAdditionalDataInstallments struct for ResponseAdditionalDataInstallments type ResponseAdditionalDataInstallments struct { - // The number of installments that the payment amount should be charged with. Example: 5 > Only relevant for card payments in countries that support installments. - InstallmentsValue string `json:"installments.value,omitempty"` // Type of installment. The value of `installmentType` should be **IssuerFinanced**. InstallmentPaymentDataInstallmentType string `json:"installmentPaymentData.installmentType,omitempty"` - // Possible values: * PayInInstallmentsOnly * PayInFullOnly * PayInFullOrInstallments - InstallmentPaymentDataPaymentOptions string `json:"installmentPaymentData.paymentOptions,omitempty"` - // Total number of installments possible for this payment. - InstallmentPaymentDataOptionItemNrNumberOfInstallments string `json:"installmentPaymentData.option[itemNr].numberOfInstallments,omitempty"` - // Interest rate for the installment period. - InstallmentPaymentDataOptionItemNrInterestRate string `json:"installmentPaymentData.option[itemNr].interestRate,omitempty"` - // Installment fee amount in minor units. - InstallmentPaymentDataOptionItemNrInstallmentFee string `json:"installmentPaymentData.option[itemNr].installmentFee,omitempty"` // Annual interest rate. InstallmentPaymentDataOptionItemNrAnnualPercentageRate string `json:"installmentPaymentData.option[itemNr].annualPercentageRate,omitempty"` // First Installment Amount in minor units. InstallmentPaymentDataOptionItemNrFirstInstallmentAmount string `json:"installmentPaymentData.option[itemNr].firstInstallmentAmount,omitempty"` - // Subsequent Installment Amount in minor units. - InstallmentPaymentDataOptionItemNrSubsequentInstallmentAmount string `json:"installmentPaymentData.option[itemNr].subsequentInstallmentAmount,omitempty"` - // Minimum number of installments possible for this payment. - InstallmentPaymentDataOptionItemNrMinimumNumberOfInstallments string `json:"installmentPaymentData.option[itemNr].minimumNumberOfInstallments,omitempty"` + // Installment fee amount in minor units. + InstallmentPaymentDataOptionItemNrInstallmentFee string `json:"installmentPaymentData.option[itemNr].installmentFee,omitempty"` + // Interest rate for the installment period. + InstallmentPaymentDataOptionItemNrInterestRate string `json:"installmentPaymentData.option[itemNr].interestRate,omitempty"` // Maximum number of installments possible for this payment. InstallmentPaymentDataOptionItemNrMaximumNumberOfInstallments string `json:"installmentPaymentData.option[itemNr].maximumNumberOfInstallments,omitempty"` + // Minimum number of installments possible for this payment. + InstallmentPaymentDataOptionItemNrMinimumNumberOfInstallments string `json:"installmentPaymentData.option[itemNr].minimumNumberOfInstallments,omitempty"` + // Total number of installments possible for this payment. + InstallmentPaymentDataOptionItemNrNumberOfInstallments string `json:"installmentPaymentData.option[itemNr].numberOfInstallments,omitempty"` + // Subsequent Installment Amount in minor units. + InstallmentPaymentDataOptionItemNrSubsequentInstallmentAmount string `json:"installmentPaymentData.option[itemNr].subsequentInstallmentAmount,omitempty"` // Total amount in minor units. InstallmentPaymentDataOptionItemNrTotalAmountDue string `json:"installmentPaymentData.option[itemNr].totalAmountDue,omitempty"` + // Possible values: * PayInInstallmentsOnly * PayInFullOnly * PayInFullOrInstallments + InstallmentPaymentDataPaymentOptions string `json:"installmentPaymentData.paymentOptions,omitempty"` + // The number of installments that the payment amount should be charged with. Example: 5 > Only relevant for card payments in countries that support installments. + InstallmentsValue string `json:"installments.value,omitempty"` } diff --git a/src/checkout/model_response_additional_data_network_tokens.go b/src/checkout/model_response_additional_data_network_tokens.go index 618af5eb6..23c69029d 100644 --- a/src/checkout/model_response_additional_data_network_tokens.go +++ b/src/checkout/model_response_additional_data_network_tokens.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,6 +15,6 @@ type ResponseAdditionalDataNetworkTokens struct { NetworkTokenAvailable string `json:"networkToken.available,omitempty"` // The Bank Identification Number of a tokenized card, which is the first six digits of a card number. NetworkTokenBin string `json:"networkToken.bin,omitempty"` - // The last four digits of a card number. + // The last four digits of a network token. NetworkTokenTokenSummary string `json:"networkToken.tokenSummary,omitempty"` } diff --git a/src/checkout/model_response_additional_data_opi.go b/src/checkout/model_response_additional_data_opi.go new file mode 100644 index 000000000..e1c5278ce --- /dev/null +++ b/src/checkout/model_response_additional_data_opi.go @@ -0,0 +1,16 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// ResponseAdditionalDataOpi struct for ResponseAdditionalDataOpi +type ResponseAdditionalDataOpi struct { + // Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + OpiTransToken string `json:"opi.transToken,omitempty"` +} diff --git a/src/checkout/model_response_additional_data_pay_pal.go b/src/checkout/model_response_additional_data_pay_pal.go index 08c401e82..12ee4e145 100644 --- a/src/checkout/model_response_additional_data_pay_pal.go +++ b/src/checkout/model_response_additional_data_pay_pal.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,14 +11,14 @@ package checkout // ResponseAdditionalDataPayPal struct for ResponseAdditionalDataPayPal type ResponseAdditionalDataPayPal struct { - // The status of the buyer's PayPal account. Example: unverified - PaypalPayerStatus string `json:"paypalPayerStatus,omitempty"` - // The buyer's country of residence. Example: NL - PaypalPayerResidenceCountry string `json:"paypalPayerResidenceCountry,omitempty"` - // The buyer's PayPal ID. Example: LF5HCWWBRV2KL - PaypalPayerId string `json:"paypalPayerId,omitempty"` // The buyer's PayPal account email address. Example: paypaltest@adyen.com PaypalEmail string `json:"paypalEmail,omitempty"` + // The buyer's PayPal ID. Example: LF5HCWWBRV2KL + PaypalPayerId string `json:"paypalPayerId,omitempty"` + // The buyer's country of residence. Example: NL + PaypalPayerResidenceCountry string `json:"paypalPayerResidenceCountry,omitempty"` + // The status of the buyer's PayPal account. Example: unverified + PaypalPayerStatus string `json:"paypalPayerStatus,omitempty"` // The eligibility for PayPal Seller Protection for this payment. Example: Ineligible PaypalProtectionEligibility string `json:"paypalProtectionEligibility,omitempty"` } diff --git a/src/checkout/model_response_additional_data_sepa.go b/src/checkout/model_response_additional_data_sepa.go index be0c9ac59..ea583e1ce 100644 --- a/src/checkout/model_response_additional_data_sepa.go +++ b/src/checkout/model_response_additional_data_sepa.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,8 +13,8 @@ package checkout type ResponseAdditionalDataSepa struct { // The transaction signature date. Format: yyyy-MM-dd SepadirectdebitDateOfSignature string `json:"sepadirectdebit.dateOfSignature,omitempty"` - // Its value corresponds to the pspReference value of the transaction. + // Its value corresponds to the pspReference value of the transaction. SepadirectdebitMandateId string `json:"sepadirectdebit.mandateId,omitempty"` - // This field can take one of the following values: * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. * First: (FRST) Initial/first collection in a series of direct debit instructions. * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. * Final: (FNAL) Last/final collection in a series of direct debit instructions. Example: OOFF + // This field can take one of the following values: * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. * First: (FRST) Initial/first collection in a series of direct debit instructions. * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. * Final: (FNAL) Last/final collection in a series of direct debit instructions. Example: OOFF SepadirectdebitSequenceType string `json:"sepadirectdebit.sequenceType,omitempty"` } diff --git a/src/checkout/model_risk_data.go b/src/checkout/model_risk_data.go index ce3656ab8..95d520147 100644 --- a/src/checkout/model_risk_data.go +++ b/src/checkout/model_risk_data.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,4 +13,10 @@ package checkout type RiskData struct { // Contains client-side data, like the device fingerprint, cookies, and specific browser settings. ClientData string `json:"clientData,omitempty"` + // Any custom fields used as part of the input to configured risk rules. + CustomFields map[string]string `json:"customFields,omitempty"` + // An integer value that is added to the normal fraud score. The value can be either positive or negative. + FraudOffset int32 `json:"fraudOffset,omitempty"` + // The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. + ProfileReference string `json:"profileReference,omitempty"` } diff --git a/src/checkout/model_samsung_pay_details.go b/src/checkout/model_samsung_pay_details.go new file mode 100644 index 000000000..8660a9ac9 --- /dev/null +++ b/src/checkout/model_samsung_pay_details.go @@ -0,0 +1,23 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// SamsungPayDetails struct for SamsungPayDetails +type SamsungPayDetails struct { + // The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + FundingSource string `json:"fundingSource,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + SamsungPayToken string `json:"samsungPayToken"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // **samsungpay** + Type string `json:"type"` +} diff --git a/src/checkout/model_sdk_ephem_pub_key.go b/src/checkout/model_sdk_ephem_pub_key.go index a3fd4f6c9..db27586f4 100644 --- a/src/checkout/model_sdk_ephem_pub_key.go +++ b/src/checkout/model_sdk_ephem_pub_key.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_sepa_direct_debit_details.go b/src/checkout/model_sepa_direct_debit_details.go new file mode 100644 index 000000000..3cf2d0b1e --- /dev/null +++ b/src/checkout/model_sepa_direct_debit_details.go @@ -0,0 +1,24 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// SepaDirectDebitDetails struct for SepaDirectDebitDetails +type SepaDirectDebitDetails struct { + // The International Bank Account Number (IBAN). + Iban string `json:"iban"` + // The name of the bank account holder. + OwnerName string `json:"ownerName"` + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // **sepadirectdebit** + Type string `json:"type"` +} diff --git a/src/checkout/model_service_error.go b/src/checkout/model_service_error.go index ed8b723b8..49e7c4ea0 100644 --- a/src/checkout/model_service_error.go +++ b/src/checkout/model_service_error.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_shopper_input.go b/src/checkout/model_shopper_input.go index df38a1b66..fb9f1f811 100644 --- a/src/checkout/model_shopper_input.go +++ b/src/checkout/model_shopper_input.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_shopper_interaction_device.go b/src/checkout/model_shopper_interaction_device.go index 2122e8b1f..06bebbd87 100644 --- a/src/checkout/model_shopper_interaction_device.go +++ b/src/checkout/model_shopper_interaction_device.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_split.go b/src/checkout/model_split.go index ca2effa29..b7f743ac7 100644 --- a/src/checkout/model_split.go +++ b/src/checkout/model_split.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_split_amount.go b/src/checkout/model_split_amount.go index 60b13f714..e796f986b 100644 --- a/src/checkout/model_split_amount.go +++ b/src/checkout/model_split_amount.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_stored_details.go b/src/checkout/model_stored_details.go index b890992ba..48ed9b1de 100644 --- a/src/checkout/model_stored_details.go +++ b/src/checkout/model_stored_details.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_stored_payment_method.go b/src/checkout/model_stored_payment_method.go index 600b0a6ff..6b84fb6de 100644 --- a/src/checkout/model_stored_payment_method.go +++ b/src/checkout/model_stored_payment_method.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_stored_payment_method_details.go b/src/checkout/model_stored_payment_method_details.go new file mode 100644 index 000000000..612ac388d --- /dev/null +++ b/src/checkout/model_stored_payment_method_details.go @@ -0,0 +1,20 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// StoredPaymentMethodDetails struct for StoredPaymentMethodDetails +type StoredPaymentMethodDetails struct { + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + // The payment method type. + Type string `json:"type"` +} diff --git a/src/checkout/model_sub_input_detail.go b/src/checkout/model_sub_input_detail.go index b46823157..6784735c7 100644 --- a/src/checkout/model_sub_input_detail.go +++ b/src/checkout/model_sub_input_detail.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,7 +12,7 @@ package checkout // SubInputDetail struct for SubInputDetail type SubInputDetail struct { // Configuration parameters for the required input. - Configuration *map[string]interface{} `json:"configuration,omitempty"` + Configuration map[string]string `json:"configuration,omitempty"` // In case of a select, the items to choose from. Items *[]Item `json:"items,omitempty"` // The value to provide in the result. diff --git a/src/checkout/model_subscription_details.go b/src/checkout/model_subscription_details.go new file mode 100644 index 000000000..7cdb687f1 --- /dev/null +++ b/src/checkout/model_subscription_details.go @@ -0,0 +1,30 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// SubscriptionDetails struct for SubscriptionDetails +type SubscriptionDetails struct { + // The billing amount of the recurring transactions. + Amount string `json:"amount"` + // The limitation rule of the billing amount. Possible values: * `max`: The transaction amount can not exceed the `amount`. * `exact`: The transaction amount should be the same as the `amount`. + AmountRule string `json:"amountRule,omitempty"` + // The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * `on`: On a specific date. * `before`: Before and on a specific date. * `after`: On and after a specific date. + BillingAttemptsRule string `json:"billingAttemptsRule,omitempty"` + // The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`. + BillingDay string `json:"billingDay,omitempty"` + // End date of the billing plan, in YYYY-MM-DD format. + EndAt string `json:"endAt"` + // The frequency with which a shopper should be charged. Possible values: daily, weekly, biWeekly, monthly, quarterly, halfYearly, yearly. + Frequency string `json:"frequency"` + // The message shown by UPI to the shopper on the approval screen. + Remarks string `json:"remarks,omitempty"` + // Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date. + StartAt string `json:"startAt,omitempty"` +} diff --git a/src/checkout/model_three_d_secure_data.go b/src/checkout/model_three_d_secure_data.go index 7dce34678..4d705b6b0 100644 --- a/src/checkout/model_three_d_secure_data.go +++ b/src/checkout/model_three_d_secure_data.go @@ -1,15 +1,14 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package checkout - // ThreeDSecureData struct for ThreeDSecureData type ThreeDSecureData struct { // In 3D Secure 1, the authentication response if the shopper was redirected. In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter. @@ -18,7 +17,7 @@ type ThreeDSecureData struct { Cavv string `json:"cavv,omitempty"` // The CAVV algorithm used. Include this only for 3D Secure 1. CavvAlgorithm string `json:"cavvAlgorithm,omitempty"` - // In 3D Secure 1, this is the enrollment response from the 3D directory server. In 3D Secure 2, this is the `transStatus` from the `ARes`. + // In 3D Secure 1, this is the enrollment response from the 3D directory server. In 3D Secure 2, this is the `transStatus` from the `ARes`. DirectoryResponse string `json:"directoryResponse,omitempty"` // Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. DsTransID string `json:"dsTransID,omitempty"` diff --git a/src/checkout/model_three_ds2_request_data.go b/src/checkout/model_three_ds2_request_data.go index b98836f53..a1092eaf2 100644 --- a/src/checkout/model_three_ds2_request_data.go +++ b/src/checkout/model_three_ds2_request_data.go @@ -1,9 +1,9 @@ /* * Adyen Checkout API * - * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v52/payments ``` + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` * - * API version: 52 + * API version: 65 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/checkout/model_update_payment_link_request.go b/src/checkout/model_update_payment_link_request.go new file mode 100644 index 000000000..f19bd0bff --- /dev/null +++ b/src/checkout/model_update_payment_link_request.go @@ -0,0 +1,16 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// UpdatePaymentLinkRequest struct for UpdatePaymentLinkRequest +type UpdatePaymentLinkRequest struct { + // Status of the payment link. Possible values: * **expired** + Status string `json:"status"` +} diff --git a/src/checkout/model_upi_details.go b/src/checkout/model_upi_details.go new file mode 100644 index 000000000..98a079053 --- /dev/null +++ b/src/checkout/model_upi_details.go @@ -0,0 +1,25 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// UpiDetails struct for UpiDetails +type UpiDetails struct { + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. + ShopperNotificationReference string `json:"shopperNotificationReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + SubscriptionDetails *SubscriptionDetails `json:"subscriptionDetails,omitempty"` + // **upi** + Type string `json:"type"` + // The virtual payment address for UPI. + VirtualPaymentAddress string `json:"virtualPaymentAddress,omitempty"` +} diff --git a/src/checkout/model_vipps_details.go b/src/checkout/model_vipps_details.go new file mode 100644 index 000000000..aa6299cc8 --- /dev/null +++ b/src/checkout/model_vipps_details.go @@ -0,0 +1,21 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// VippsDetails struct for VippsDetails +type VippsDetails struct { + // This is the `recurringDetailReference` returned in the response when you created the token. + RecurringDetailReference string `json:"recurringDetailReference,omitempty"` + // This is the `recurringDetailReference` returned in the response when you created the token. + StoredPaymentMethodId string `json:"storedPaymentMethodId,omitempty"` + TelephoneNumber string `json:"telephoneNumber"` + // **vipps** + Type string `json:"type"` +} diff --git a/src/checkout/model_visa_checkout_details.go b/src/checkout/model_visa_checkout_details.go new file mode 100644 index 000000000..8779a9cfc --- /dev/null +++ b/src/checkout/model_visa_checkout_details.go @@ -0,0 +1,19 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// VisaCheckoutDetails struct for VisaCheckoutDetails +type VisaCheckoutDetails struct { + // The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + FundingSource string `json:"fundingSource,omitempty"` + // **visacheckout** + Type string `json:"type"` + VisaCheckoutCallId string `json:"visaCheckoutCallId"` +} diff --git a/src/checkout/model_we_chat_pay_details.go b/src/checkout/model_we_chat_pay_details.go new file mode 100644 index 000000000..9071f990a --- /dev/null +++ b/src/checkout/model_we_chat_pay_details.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// WeChatPayDetails struct for WeChatPayDetails +type WeChatPayDetails struct { + AppId string `json:"appId,omitempty"` + Openid string `json:"openid,omitempty"` + // **wechatpay** + Type string `json:"type"` +} diff --git a/src/checkout/model_we_chat_pay_mini_program_details.go b/src/checkout/model_we_chat_pay_mini_program_details.go new file mode 100644 index 000000000..b365b7d8f --- /dev/null +++ b/src/checkout/model_we_chat_pay_mini_program_details.go @@ -0,0 +1,18 @@ +/* + * Adyen Checkout API + * + * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v65/payments ``` + * + * API version: 65 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package checkout +// WeChatPayMiniProgramDetails struct for WeChatPayMiniProgramDetails +type WeChatPayMiniProgramDetails struct { + AppId string `json:"appId,omitempty"` + Openid string `json:"openid,omitempty"` + // **wechatpayMiniProgram** + Type string `json:"type"` +} diff --git a/src/checkoututility/README.md b/src/checkoututility/README.md deleted file mode 100644 index 7668b689c..000000000 --- a/src/checkoututility/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# Go API client for checkoututility - -A web service containing utility functions available for merchants integrating with Checkout APIs. -## Authentication -Each request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: - -``` -curl --H \"Content-Type: application/json\" \\ --H \"X-API-Key: Your_Checkout_API_key\" \\ -... -``` -Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). - -## Versioning -Checkout 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://checkout-test.adyen.com/v1/originKeys -``` - -## Overview -This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. - -- API version: 1 -- Package version: 1.0.0 -- Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen -For more information, please visit [https://support.adyen.com/](https://support.adyen.com/) diff --git a/src/checkoututility/api/openapi.yaml b/src/checkoututility/api/openapi.yaml deleted file mode 100644 index e05ca54e0..000000000 --- a/src/checkoututility/api/openapi.yaml +++ /dev/null @@ -1,86 +0,0 @@ -openapi: 3.0.0 -info: - contact: - email: support@adyen.com - name: Adyen Support - url: https://support.adyen.com/ - description: |- - A web service containing utility functions available for merchants integrating with Checkout APIs. - ## Authentication - Each request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: - - ``` - curl - -H "Content-Type: application/json" \ - -H "X-API-Key: Your_Checkout_API_key" \ - ... - ``` - Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). - - ## Versioning - Checkout 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://checkout-test.adyen.com/v1/originKeys - ``` - termsOfService: https://www.adyen.com/legal/terms-and-conditions - title: Adyen Checkout Utility API - version: "1" -servers: -- url: https://checkout-test.adyen.com/v1 -paths: - /originKeys: - post: - description: This operation takes the origin domains and returns a JSON object - containing the corresponding origin keys for the domains. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CheckoutUtilityRequest' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CheckoutUtilityResponse' - description: OK - the request has succeeded. - "400": - description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. - "401": - description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. - "403": - description: Forbidden - insufficient permissions to process the request. - summary: Create originKey values for one or more merchant domains. - x-groupName: General - x-sortIndex: 0 -components: - schemas: - CheckoutUtilityRequest: - example: - originDomains: - - originDomains - - originDomains - properties: - originDomains: - description: The list of origin domains, for which origin keys are requested. - items: - type: string - type: array - required: - - originDomains - CheckoutUtilityResponse: - example: - originKeys: '{}' - properties: - originKeys: - description: The list of origin keys for all requested domains. For each - list item, the key is the domain and the value is the origin key. - type: object -x-groups: -- General diff --git a/src/checkoututility/api_default.go b/src/checkoututility/api_default.go deleted file mode 100644 index c6025066d..000000000 --- a/src/checkoututility/api_default.go +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Adyen Checkout Utility API - * - * A web service containing utility functions available for merchants integrating with Checkout APIs. ## Authentication Each request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v1/originKeys ``` - * - * API version: 1 - * Contact: support@adyen.com - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package checkoututility - -import ( - _context "context" - _nethttp "net/http" - - "github.com/adyen/adyen-go-api-library/v3/src/common" -) - -// CheckoutUtility CheckoutUtility service -type CheckoutUtility common.Service - -/* -OriginKeys Create originKey values for one or more merchant domains. -This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. - * @param request CheckoutUtilityRequest - reference of CheckoutUtilityRequest). - * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return CheckoutUtilityResponse -*/ -func (a CheckoutUtility) OriginKeys(req *CheckoutUtilityRequest, ctxs ..._context.Context) (CheckoutUtilityResponse, *_nethttp.Response, error) { - res := &CheckoutUtilityResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/originKeys", ctxs...) - return *res, httpRes, err -} diff --git a/src/checkoututility/model_checkout_utility_request.go b/src/checkoututility/model_checkout_utility_request.go deleted file mode 100644 index 671536c4b..000000000 --- a/src/checkoututility/model_checkout_utility_request.go +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Adyen Checkout Utility API - * - * A web service containing utility functions available for merchants integrating with Checkout APIs. ## Authentication Each request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v1/originKeys ``` - * - * API version: 1 - * Contact: support@adyen.com - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package checkoututility -// CheckoutUtilityRequest struct for CheckoutUtilityRequest -type CheckoutUtilityRequest struct { - // The list of origin domains, for which origin keys are requested. - OriginDomains []string `json:"originDomains"` -} diff --git a/src/checkoututility/model_checkout_utility_response.go b/src/checkoututility/model_checkout_utility_response.go deleted file mode 100644 index 462f03fa5..000000000 --- a/src/checkoututility/model_checkout_utility_response.go +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Adyen Checkout Utility API - * - * A web service containing utility functions available for merchants integrating with Checkout APIs. ## Authentication Each request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v1/originKeys ``` - * - * API version: 1 - * Contact: support@adyen.com - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package checkoututility -// CheckoutUtilityResponse struct for CheckoutUtilityResponse -type CheckoutUtilityResponse struct { - // The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. - OriginKeys *map[string]interface{} `json:"originKeys,omitempty"` -} diff --git a/src/common/client.go b/src/common/client.go index 406acfb56..91baf12da 100644 --- a/src/common/client.go +++ b/src/common/client.go @@ -50,10 +50,8 @@ type Client struct { Cfg *Config } -// MakeHTTPPostRequest is a generic method used to make HTTP POST requests -func (c *Client) MakeHTTPPostRequest(req interface{}, res interface{}, path string, ctxs ...context.Context) (*http.Response, error) { - httpMethod := http.MethodPost - +// CreateHTTPRequest is used as base to create HTTP request for all methods (GET, POST, PATCH...) +func CreateHTTPRequest(c *Client, httpMethod string, req interface{}, res interface{}, path string, ctxs []context.Context) (*http.Response, error) { // create path and map variables headerParams := make(map[string]string) queryParams := url.Values{} @@ -112,6 +110,22 @@ func (c *Client) MakeHTTPPostRequest(req interface{}, res interface{}, path stri return httpResponse, nil } +// MakeHTTPPostRequest is a generic method used to make HTTP POST requests +func (c *Client) MakeHTTPPostRequest(req interface{}, res interface{}, path string, ctxs ...context.Context) (*http.Response, error) { + return CreateHTTPRequest(c, http.MethodPost, req, res, path, ctxs) +} + +// MakeHTTPGetRequest is a generic method used to make HTTP GET requests +func (c *Client) MakeHTTPGetRequest(res interface{}, path string, ctxs ...context.Context) (*http.Response, error) { + var req interface{} + return CreateHTTPRequest(c, http.MethodGet, req, res, path, ctxs) +} + +// MakeHTTPPatchRequest is a generic method used to make HTTP PATCH requests +func (c *Client) MakeHTTPPatchRequest(req interface{}, res interface{}, path string, ctxs ...context.Context) (*http.Response, error) { + return CreateHTTPRequest(c, http.MethodPatch, req, res, path, ctxs) +} + // CallAPI do the Request. func (c *Client) CallAPI(request *http.Request) (*http.Response, error) { if c.Cfg.Debug { diff --git a/src/common/configuration.go b/src/common/configuration.go index 31b3c6142..e19c69887 100644 --- a/src/common/configuration.go +++ b/src/common/configuration.go @@ -3,7 +3,7 @@ * * Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including One-Click and 3D Secure), mobile wallets, and local payment methods (e.g. iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout). ## Authentication Each Request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_Checkout_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Checkout 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://checkout-test.adyen.com/v51/payments ``` * - * API version: 51 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -61,7 +61,7 @@ const ( const ( LibName = "adyen-go-api-library" - LibVersion = "3.0.0" + LibVersion = "4.0.0" ) // Config stores the configuration of the API client @@ -75,6 +75,7 @@ type Config struct { ApiKey string `json:"apiKey,omitempty"` ConnectionTimeoutMillis time.Duration `json:"connectionTimeoutMillis,omitempty"` CertificatePath string `json:"certificatePath,omitempty"` + DisputesEndpoint string `json:"disputesEndpoint,omitempty"` //Checkout Specific CheckoutEndpoint string `json:"checkoutEndpoint,omitempty"` diff --git a/src/checkoututility/.gitignore b/src/disputes/.gitignore old mode 100644 new mode 100755 similarity index 100% rename from src/checkoututility/.gitignore rename to src/disputes/.gitignore diff --git a/src/checkoututility/.openapi-generator-ignore b/src/disputes/.openapi-generator-ignore old mode 100644 new mode 100755 similarity index 100% rename from src/checkoututility/.openapi-generator-ignore rename to src/disputes/.openapi-generator-ignore diff --git a/src/checkoututility/.openapi-generator/VERSION b/src/disputes/.openapi-generator/VERSION old mode 100644 new mode 100755 similarity index 100% rename from src/checkoututility/.openapi-generator/VERSION rename to src/disputes/.openapi-generator/VERSION diff --git a/src/disputes/README.md b/src/disputes/README.md new file mode 100755 index 000000000..a31de1aad --- /dev/null +++ b/src/disputes/README.md @@ -0,0 +1,26 @@ +# Go API client for disputes + +This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. + +For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). + +## Authentication +Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: + +``` +curl +-H \"Content-Type: application/json\" \\ +-H \"X-API-Key: Your_API_key\" \\ +... +``` +Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + +``` + +## Overview +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. + +- API version: 1 +- Package version: 1.0.0 +- Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen +For more information, please visit [https://support.adyen.com/](https://support.adyen.com/) diff --git a/src/disputes/api/openapi.yaml b/src/disputes/api/openapi.yaml new file mode 100755 index 000000000..93de808ce --- /dev/null +++ b/src/disputes/api/openapi.yaml @@ -0,0 +1,446 @@ +openapi: 3.0.3 +info: + contact: + email: support@adyen.com + name: Adyen Support + url: https://support.adyen.com/ + description: |- + This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. + + For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). + + ## Authentication + Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: + + ``` + curl + -H "Content-Type: application/json" \ + -H "X-API-Key: Your_API_key" \ + ... + ``` + Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ``` + termsOfService: https://www.adyen.com/legal/terms-and-conditions + title: Dispute service API + version: "1" +servers: +- url: / +paths: + /defendDispute: + post: + description: Defend the dispute with the given reason code. + operationId: post-defendDispute + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DefendDisputeRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DefendDisputeResponse' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Defend dispute + x-groupName: General + x-sortIndex: 1 + /deleteDisputeDefenseDocument: + post: + description: Delete a dispute defense document. + operationId: post-deleteDisputeDefenseDocument + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteDefenseDocumentRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteDefenseDocumentResponse' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Delete dispute defense document + x-groupName: General + x-sortIndex: 1 + /downloadDisputeDefenseDocument: + get: + description: Download a dispute defense document. + operationId: get-downloadDisputeDefenseDocument + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DownloadDefenseDocumentRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DownloadDefenseDocumentResponse' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Download Dispute defense document + x-groupName: General + x-sortIndex: 1 + /retrieveApplicableDefenseReasons: + get: + description: Retrieve a list of possible defense reasons with required documents + for the given dispute. + operationId: get-retrieveApplicableDefenseReasons + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DefenseReasonsRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DefenseReasonsResponse' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Retrieve applicable defense reasons + x-groupName: General + x-sortIndex: 1 + /supplyDefenseDocument: + post: + description: Supply a dispute defense document. + operationId: post-supplyDefenseDocument + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SupplyDefenseDocumentRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/SupplyDefenseDocumentResponse' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Supply defense document + x-groupName: General + x-sortIndex: 1 +components: + schemas: + DefendDisputeRequest: + example: + merchantAccountCode: merchantAccountCode + defenseReasonCode: defenseReasonCode + disputePspReference: disputePspReference + properties: + defenseReasonCode: + description: The reasoncode for this dispute + type: string + disputePspReference: + description: The psp reference of the dispute + type: string + merchantAccountCode: + description: The merchant account identifier + type: string + required: + - defenseReasonCode + - disputePspReference + - merchantAccountCode + DefendDisputeResponse: + example: + disputeServiceResult: + success: true + errorMessage: errorMessage + properties: + disputeServiceResult: + $ref: '#/components/schemas/DisputeServiceResult' + required: + - disputeServiceResult + DefenseDocument: + example: + defenseDocumentTypeCode: defenseDocumentTypeCode + contentType: contentType + content: content + properties: + content: + description: The content of the defense document + format: byte + type: string + contentType: + description: The content type of the defense document + type: string + defenseDocumentTypeCode: + description: The typecode for the defense document type + type: string + required: + - content + - contentType + - defenseDocumentTypeCode + DefenseDocumentType: + example: + requirementLevel: requirementLevel + available: true + defenseDocumentTypeCode: defenseDocumentTypeCode + properties: + available: + description: Indicates if this document type is available + type: boolean + defenseDocumentTypeCode: + description: The typecode for the defense document type + type: string + requirementLevel: + description: The requirement level for the defense document type + type: string + required: + - available + - defenseDocumentTypeCode + - requirementLevel + DefenseReason: + example: + defenseReasonCode: defenseReasonCode + defenseDocumentTypes: + - requirementLevel: requirementLevel + available: true + defenseDocumentTypeCode: defenseDocumentTypeCode + - requirementLevel: requirementLevel + available: true + defenseDocumentTypeCode: defenseDocumentTypeCode + satisfied: true + properties: + defenseDocumentTypes: + description: Defense ducoment types + items: + $ref: '#/components/schemas/DefenseDocumentType' + type: array + defenseReasonCode: + description: The reason code for this specific defense + type: string + satisfied: + description: Indicates if this defense reason is satisfied + type: boolean + required: + - defenseReasonCode + - satisfied + DefenseReasonsRequest: + example: + merchantAccountCode: merchantAccountCode + disputePspReference: disputePspReference + properties: + disputePspReference: + description: The psp reference of the dispute + type: string + merchantAccountCode: + description: The merchant account identifier + type: string + required: + - disputePspReference + - merchantAccountCode + DefenseReasonsResponse: + example: + defenseReasons: + - defenseReasonCode: defenseReasonCode + defenseDocumentTypes: + - requirementLevel: requirementLevel + available: true + defenseDocumentTypeCode: defenseDocumentTypeCode + - requirementLevel: requirementLevel + available: true + defenseDocumentTypeCode: defenseDocumentTypeCode + satisfied: true + - defenseReasonCode: defenseReasonCode + defenseDocumentTypes: + - requirementLevel: requirementLevel + available: true + defenseDocumentTypeCode: defenseDocumentTypeCode + - requirementLevel: requirementLevel + available: true + defenseDocumentTypeCode: defenseDocumentTypeCode + satisfied: true + disputeServiceResult: + success: true + errorMessage: errorMessage + properties: + defenseReasons: + description: Defense reasons + items: + $ref: '#/components/schemas/DefenseReason' + type: array + disputeServiceResult: + $ref: '#/components/schemas/DisputeServiceResult' + required: + - disputeServiceResult + DeleteDefenseDocumentRequest: + example: + merchantAccountCode: merchantAccountCode + disputePspReference: disputePspReference + defenseDocumentType: defenseDocumentType + properties: + defenseDocumentType: + description: The specific type of the defense document + type: string + disputePspReference: + description: The psp reference of the dispute + type: string + merchantAccountCode: + description: The merchant account identifier + type: string + required: + - defenseDocumentType + - disputePspReference + - merchantAccountCode + DeleteDefenseDocumentResponse: + example: + disputeServiceResult: + success: true + errorMessage: errorMessage + properties: + disputeServiceResult: + $ref: '#/components/schemas/DisputeServiceResult' + required: + - disputeServiceResult + DisputeServiceResult: + example: + success: true + errorMessage: errorMessage + properties: + errorMessage: + description: error message, empty if request was successfull + type: string + success: + description: Indicates whether or not the request succeeded + type: boolean + required: + - success + DownloadDefenseDocumentRequest: + example: + merchantAccountCode: merchantAccountCode + disputePspReference: disputePspReference + defenseDocumentType: defenseDocumentType + properties: + defenseDocumentType: + description: The specific type of the defense document + type: string + disputePspReference: + description: The psp reference of the dispute + type: string + merchantAccountCode: + description: The merchant account identifier + type: string + required: + - defenseDocumentType + - disputePspReference + - merchantAccountCode + DownloadDefenseDocumentResponse: + example: + disputeServiceResult: + success: true + errorMessage: errorMessage + contentType: contentType + content: content + properties: + content: + description: The content of the dispute defense document + format: byte + type: string + contentType: + description: The content type of the dispute defense document + type: string + disputeServiceResult: + $ref: '#/components/schemas/DisputeServiceResult' + required: + - disputeServiceResult + SupplyDefenseDocumentRequest: + example: + merchantAccountCode: merchantAccountCode + disputePspReference: disputePspReference + defenseDocuments: + - defenseDocumentTypeCode: defenseDocumentTypeCode + contentType: contentType + content: content + - defenseDocumentTypeCode: defenseDocumentTypeCode + contentType: contentType + content: content + properties: + defenseDocuments: + description: The defense documents to be supplied + items: + $ref: '#/components/schemas/DefenseDocument' + type: array + disputePspReference: + description: The psp reference of the dispute + type: string + merchantAccountCode: + description: The merchant account identifier + type: string + required: + - defenseDocuments + - disputePspReference + - merchantAccountCode + SupplyDefenseDocumentResponse: + example: + disputeServiceResult: + success: true + errorMessage: errorMessage + properties: + disputeServiceResult: + $ref: '#/components/schemas/DisputeServiceResult' + required: + - disputeServiceResult + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http +x-groups: +- General diff --git a/src/disputes/api_default.go b/src/disputes/api_default.go new file mode 100755 index 000000000..e5e060585 --- /dev/null +++ b/src/disputes/api_default.go @@ -0,0 +1,86 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes + +import ( + _context "context" + _nethttp "net/http" + + "github.com/adyen/adyen-go-api-library/v4/src/common" +) + +// Disputes Disputes service +type Disputes common.Service + +/* +GetDownloadDisputeDefenseDocument Download Dispute defense document +Download a dispute defense document. + * @param request DownloadDefenseDocumentRequest - reference of DownloadDefenseDocumentRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return DownloadDefenseDocumentResponse +*/ +func (a Disputes) DownloadDisputeDefenseDocument(req *DownloadDefenseDocumentRequest, ctxs ..._context.Context) (DownloadDefenseDocumentResponse, *_nethttp.Response, error) { + res := &DownloadDefenseDocumentResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/downloadDisputeDefenseDocument", ctxs...) + return *res, httpRes, err +} + +/* +GetRetrieveApplicableDefenseReasons Retrieve applicable defense reasons +Retrieve a list of possible defense reasons with required documents for the given dispute. + * @param request DefenseReasonsRequest - reference of DefenseReasonsRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return DefenseReasonsResponse +*/ +func (a Disputes) RetrieveApplicableDefenseReasons(req *DefenseReasonsRequest, ctxs ..._context.Context) (DefenseReasonsResponse, *_nethttp.Response, error) { + res := &DefenseReasonsResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/retrieveApplicableDefenseReasons", ctxs...) + return *res, httpRes, err +} + +/* +PostDefendDispute Defend dispute +Defend the dispute with the given reason code. + * @param request DefendDisputeRequest - reference of DefendDisputeRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return DefendDisputeResponse +*/ +func (a Disputes) DefendDispute(req *DefendDisputeRequest, ctxs ..._context.Context) (DefendDisputeResponse, *_nethttp.Response, error) { + res := &DefendDisputeResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/defendDispute", ctxs...) + return *res, httpRes, err +} + +/* +PostDeleteDisputeDefenseDocument Delete dispute defense document +Delete a dispute defense document. + * @param request DeleteDefenseDocumentRequest - reference of DeleteDefenseDocumentRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return DeleteDefenseDocumentResponse +*/ +func (a Disputes) DeleteDisputeDefenseDocument(req *DeleteDefenseDocumentRequest, ctxs ..._context.Context) (DeleteDefenseDocumentResponse, *_nethttp.Response, error) { + res := &DeleteDefenseDocumentResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/deleteDisputeDefenseDocument", ctxs...) + return *res, httpRes, err +} + +/* +PostSupplyDefenseDocument Supply defense document +Supply a dispute defense document. + * @param request SupplyDefenseDocumentRequest - reference of SupplyDefenseDocumentRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return SupplyDefenseDocumentResponse +*/ +func (a Disputes) SupplyDefenseDocument(req *SupplyDefenseDocumentRequest, ctxs ..._context.Context) (SupplyDefenseDocumentResponse, *_nethttp.Response, error) { + res := &SupplyDefenseDocumentResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/supplyDefenseDocument", ctxs...) + return *res, httpRes, err +} diff --git a/src/disputes/model_defend_dispute_request.go b/src/disputes/model_defend_dispute_request.go new file mode 100755 index 000000000..853823c4b --- /dev/null +++ b/src/disputes/model_defend_dispute_request.go @@ -0,0 +1,20 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DefendDisputeRequest struct for DefendDisputeRequest +type DefendDisputeRequest struct { + // The reasoncode for this dispute + DefenseReasonCode string `json:"defenseReasonCode"` + // The psp reference of the dispute + DisputePspReference string `json:"disputePspReference"` + // The merchant account identifier + MerchantAccountCode string `json:"merchantAccountCode"` +} diff --git a/src/disputes/model_defend_dispute_response.go b/src/disputes/model_defend_dispute_response.go new file mode 100755 index 000000000..a6ab42110 --- /dev/null +++ b/src/disputes/model_defend_dispute_response.go @@ -0,0 +1,15 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DefendDisputeResponse struct for DefendDisputeResponse +type DefendDisputeResponse struct { + DisputeServiceResult DisputeServiceResult `json:"disputeServiceResult"` +} diff --git a/src/disputes/model_defense_document.go b/src/disputes/model_defense_document.go new file mode 100755 index 000000000..cf9479762 --- /dev/null +++ b/src/disputes/model_defense_document.go @@ -0,0 +1,20 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DefenseDocument struct for DefenseDocument +type DefenseDocument struct { + // The content of the defense document + Content string `json:"content"` + // The content type of the defense document + ContentType string `json:"contentType"` + // The typecode for the defense document type + DefenseDocumentTypeCode string `json:"defenseDocumentTypeCode"` +} diff --git a/src/disputes/model_defense_document_type.go b/src/disputes/model_defense_document_type.go new file mode 100755 index 000000000..8b5fe5fde --- /dev/null +++ b/src/disputes/model_defense_document_type.go @@ -0,0 +1,20 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DefenseDocumentType struct for DefenseDocumentType +type DefenseDocumentType struct { + // Indicates if this document type is available + Available bool `json:"available"` + // The typecode for the defense document type + DefenseDocumentTypeCode string `json:"defenseDocumentTypeCode"` + // The requirement level for the defense document type + RequirementLevel string `json:"requirementLevel"` +} diff --git a/src/disputes/model_defense_reason.go b/src/disputes/model_defense_reason.go new file mode 100755 index 000000000..4a4248a5c --- /dev/null +++ b/src/disputes/model_defense_reason.go @@ -0,0 +1,20 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DefenseReason struct for DefenseReason +type DefenseReason struct { + // Defense ducoment types + DefenseDocumentTypes *[]DefenseDocumentType `json:"defenseDocumentTypes,omitempty"` + // The reason code for this specific defense + DefenseReasonCode string `json:"defenseReasonCode"` + // Indicates if this defense reason is satisfied + Satisfied bool `json:"satisfied"` +} diff --git a/src/disputes/model_defense_reasons_request.go b/src/disputes/model_defense_reasons_request.go new file mode 100755 index 000000000..35e5df245 --- /dev/null +++ b/src/disputes/model_defense_reasons_request.go @@ -0,0 +1,18 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DefenseReasonsRequest struct for DefenseReasonsRequest +type DefenseReasonsRequest struct { + // The psp reference of the dispute + DisputePspReference string `json:"disputePspReference"` + // The merchant account identifier + MerchantAccountCode string `json:"merchantAccountCode"` +} diff --git a/src/disputes/model_defense_reasons_response.go b/src/disputes/model_defense_reasons_response.go new file mode 100755 index 000000000..ffc31d3bf --- /dev/null +++ b/src/disputes/model_defense_reasons_response.go @@ -0,0 +1,17 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DefenseReasonsResponse struct for DefenseReasonsResponse +type DefenseReasonsResponse struct { + // Defense reasons + DefenseReasons *[]DefenseReason `json:"defenseReasons,omitempty"` + DisputeServiceResult DisputeServiceResult `json:"disputeServiceResult"` +} diff --git a/src/disputes/model_delete_defense_document_request.go b/src/disputes/model_delete_defense_document_request.go new file mode 100755 index 000000000..f99813da6 --- /dev/null +++ b/src/disputes/model_delete_defense_document_request.go @@ -0,0 +1,20 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DeleteDefenseDocumentRequest struct for DeleteDefenseDocumentRequest +type DeleteDefenseDocumentRequest struct { + // The specific type of the defense document + DefenseDocumentType string `json:"defenseDocumentType"` + // The psp reference of the dispute + DisputePspReference string `json:"disputePspReference"` + // The merchant account identifier + MerchantAccountCode string `json:"merchantAccountCode"` +} diff --git a/src/disputes/model_delete_defense_document_response.go b/src/disputes/model_delete_defense_document_response.go new file mode 100755 index 000000000..83418c5d0 --- /dev/null +++ b/src/disputes/model_delete_defense_document_response.go @@ -0,0 +1,15 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DeleteDefenseDocumentResponse struct for DeleteDefenseDocumentResponse +type DeleteDefenseDocumentResponse struct { + DisputeServiceResult DisputeServiceResult `json:"disputeServiceResult"` +} diff --git a/src/disputes/model_dispute_service_result.go b/src/disputes/model_dispute_service_result.go new file mode 100755 index 000000000..65b41c059 --- /dev/null +++ b/src/disputes/model_dispute_service_result.go @@ -0,0 +1,18 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DisputeServiceResult struct for DisputeServiceResult +type DisputeServiceResult struct { + // error message, empty if request was successfull + ErrorMessage string `json:"errorMessage,omitempty"` + // Indicates whether or not the request succeeded + Success bool `json:"success"` +} diff --git a/src/disputes/model_download_defense_document_request.go b/src/disputes/model_download_defense_document_request.go new file mode 100755 index 000000000..94f22b8b6 --- /dev/null +++ b/src/disputes/model_download_defense_document_request.go @@ -0,0 +1,20 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DownloadDefenseDocumentRequest struct for DownloadDefenseDocumentRequest +type DownloadDefenseDocumentRequest struct { + // The specific type of the defense document + DefenseDocumentType string `json:"defenseDocumentType"` + // The psp reference of the dispute + DisputePspReference string `json:"disputePspReference"` + // The merchant account identifier + MerchantAccountCode string `json:"merchantAccountCode"` +} diff --git a/src/disputes/model_download_defense_document_response.go b/src/disputes/model_download_defense_document_response.go new file mode 100755 index 000000000..adc416faf --- /dev/null +++ b/src/disputes/model_download_defense_document_response.go @@ -0,0 +1,19 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// DownloadDefenseDocumentResponse struct for DownloadDefenseDocumentResponse +type DownloadDefenseDocumentResponse struct { + // The content of the dispute defense document + Content string `json:"content,omitempty"` + // The content type of the dispute defense document + ContentType string `json:"contentType,omitempty"` + DisputeServiceResult DisputeServiceResult `json:"disputeServiceResult"` +} diff --git a/src/disputes/model_supply_defense_document_request.go b/src/disputes/model_supply_defense_document_request.go new file mode 100755 index 000000000..e21d768c2 --- /dev/null +++ b/src/disputes/model_supply_defense_document_request.go @@ -0,0 +1,20 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// SupplyDefenseDocumentRequest struct for SupplyDefenseDocumentRequest +type SupplyDefenseDocumentRequest struct { + // The defense documents to be supplied + DefenseDocuments []DefenseDocument `json:"defenseDocuments"` + // The psp reference of the dispute + DisputePspReference string `json:"disputePspReference"` + // The merchant account identifier + MerchantAccountCode string `json:"merchantAccountCode"` +} diff --git a/src/disputes/model_supply_defense_document_response.go b/src/disputes/model_supply_defense_document_response.go new file mode 100755 index 000000000..1d2268647 --- /dev/null +++ b/src/disputes/model_supply_defense_document_response.go @@ -0,0 +1,15 @@ +/* + * Dispute service API + * + * This API provides endpoints for dispute management. You can use the API to retrieve defense reasons, supply defense ducoments, delete defense documents, upload chargebacks or accept disputes. For more information on using the APIs, refer to [Dispute service](https://docs.adyen.com/risk-management/disputes-api). ## Authentication Each request to the Dispute API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ``` + * + * API version: 1 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package disputes +// SupplyDefenseDocumentResponse struct for SupplyDefenseDocumentResponse +type SupplyDefenseDocumentResponse struct { + DisputeServiceResult DisputeServiceResult `json:"disputeServiceResult"` +} diff --git a/src/hmacvalidator/hmacvalidator.go b/src/hmacvalidator/hmacvalidator.go index 832364e43..c074d2b87 100644 --- a/src/hmacvalidator/hmacvalidator.go +++ b/src/hmacvalidator/hmacvalidator.go @@ -11,7 +11,7 @@ import ( "strconv" "strings" - "github.com/adyen/adyen-go-api-library/v3/src/notification" + "github.com/adyen/adyen-go-api-library/v4/src/notification" ) // CalculateHmac calculates the SHA-256 HMAC for the given data and key diff --git a/src/hmacvalidator/hmacvalidator_test.go b/src/hmacvalidator/hmacvalidator_test.go index a18089d41..b22f60da0 100644 --- a/src/hmacvalidator/hmacvalidator_test.go +++ b/src/hmacvalidator/hmacvalidator_test.go @@ -4,7 +4,7 @@ import ( "testing" "time" - "github.com/adyen/adyen-go-api-library/v3/src/notification" + "github.com/adyen/adyen-go-api-library/v4/src/notification" "github.com/stretchr/testify/assert" ) diff --git a/src/notification/notification_handler.go b/src/notification/notification_handler.go index a2fa04144..abd11d876 100644 --- a/src/notification/notification_handler.go +++ b/src/notification/notification_handler.go @@ -3,7 +3,7 @@ package notification import ( "encoding/json" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // NotificationService used to namespace this util under the client for consistency and for future prooffing if this ever requires api access diff --git a/src/payments/README.md b/src/payments/README.md index 9272c0e1e..b6fae345b 100644 --- a/src/payments/README.md +++ b/src/payments/README.md @@ -20,13 +20,13 @@ Payments API supports versioning of its endpoints through a version suffix in th For example: ``` -https://pal-test.adyen.com/pal/servlet/Payment/v52/authorise +https://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 52 +- API version: 64 - Package version: 1.0.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit [https://support.adyen.com/](https://support.adyen.com/) diff --git a/src/payments/api/openapi.yaml b/src/payments/api/openapi.yaml index 5f56d22aa..eb8967b1f 100644 --- a/src/payments/api/openapi.yaml +++ b/src/payments/api/openapi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.0.3 info: contact: email: support@adyen.com @@ -25,13 +25,13 @@ info: For example: ``` - https://pal-test.adyen.com/pal/servlet/Payment/v52/authorise + https://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` termsOfService: https://www.adyen.com/legal/terms-and-conditions title: Adyen Payment API - version: "52" + version: "64" servers: -- url: https://pal-test.adyen.com/pal/servlet/Payment/v52 +- url: https://pal-test.adyen.com/pal/servlet/Payment/v64 paths: /adjustAuthorisation: post: @@ -39,6 +39,7 @@ paths: Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables tipping, improving the chances your authorisation will be valid, charging the shopper when they have already left the merchant premises, etc. For more information, refer to [Adjust Authorisation](https://docs.adyen.com/checkout/adjust-authorisation). + operationId: post-adjustAuthorisation requestBody: content: application/json: @@ -53,14 +54,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Increases or decreases the authorised amount. x-groupName: Modifications x-sortIndex: 6 @@ -70,6 +71,7 @@ paths: Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation. For more information, refer to [Classic integration](https://docs.adyen.com/classic-integration). + operationId: post-authorise requestBody: content: application/json: @@ -84,14 +86,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Creates a payment authorisation. x-groupName: General x-sortIndex: 1 @@ -101,6 +103,7 @@ paths: For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure. For more information, refer to [3D Secure](https://docs.adyen.com/classic-integration/3d-secure). + operationId: post-authorise3d requestBody: content: application/json: @@ -115,14 +118,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Completes a 3D Secure payment authorisation. x-groupName: General x-sortIndex: 2 @@ -132,6 +135,7 @@ paths: For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters. For more information, refer to [3D Secure 2](https://docs.adyen.com/checkout/3d-secure/native-3ds2). + operationId: post-authorise3ds2 requestBody: content: application/json: @@ -146,14 +150,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Completes a 3D Secure 2 payment authorisation. x-groupName: General x-sortIndex: 3 @@ -163,6 +167,7 @@ paths: Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures. For more information, refer to [Cancel](https://docs.adyen.com/checkout/cancel). + operationId: post-cancel requestBody: content: application/json: @@ -177,14 +182,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Cancels an authorised payment. x-groupName: Modifications x-sortIndex: 2 @@ -196,6 +201,7 @@ paths: > Do not use this request for payments that involve (multiple) partial captures. For more information, refer to [Cancel or refund](https://docs.adyen.com/checkout/cancel-or-refund). + operationId: post-cancelOrRefund requestBody: content: application/json: @@ -208,14 +214,16 @@ paths: schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. - "422": - description: Unprocessable Entity - a request validation error. + "400": + description: Bad Request - a problem reading or understanding the request. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Cancels or refunds a payment. x-groupName: Modifications x-sortIndex: 4 @@ -227,6 +235,7 @@ paths: Payment methods, which automatically capture as part of authorisation, don't need to be captured, but submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary. For more information, refer to [Capture](https://docs.adyen.com/checkout/capture). + operationId: post-capture requestBody: content: application/json: @@ -241,21 +250,54 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Captures an authorised payment. x-groupName: Modifications x-sortIndex: 1 + /donate: + post: + description: |- + Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment. + + For more information, see [Donate](https://docs.adyen.com/checkout/donate). + operationId: post-donate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DonationRequest' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + "400": + description: Bad Request - a problem reading or understanding the request. + "401": + description: Unauthorized - authentication required. + "403": + description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Creates a payment for the specified donation. + x-groupName: Modifications + x-sortIndex: 6 /getAuthenticationResult: post: description: Return the authentication result after doing a 3D Secure authentication only. + operationId: post-getAuthenticationResult requestBody: content: application/json: @@ -270,14 +312,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Return the authentication result after doing a 3D Secure authentication only. x-groupName: General @@ -291,6 +333,7 @@ paths: > A margin above the captured limit can be configured to cover shipping/handling costs. For more information, refer to [Refund](https://docs.adyen.com/checkout/refund). + operationId: post-refund requestBody: content: application/json: @@ -303,14 +346,16 @@ paths: schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. - "422": - description: Unprocessable Entity - a request validation error. + "400": + description: Bad Request - a problem reading or understanding the request. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Refunds a captured payment. x-groupName: Modifications x-sortIndex: 3 @@ -318,6 +363,7 @@ paths: post: description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. + operationId: post-retrieve3ds2Result requestBody: content: application/json: @@ -332,14 +378,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. x-groupName: General @@ -352,6 +398,7 @@ paths: In your call, refer to the original payment by using the `reference` that you specified in your payment request. For more information, see [Technical cancel](https://docs.adyen.com/checkout/cancel#technical-cancel). + operationId: post-technicalCancel requestBody: content: application/json: @@ -366,14 +413,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Cancels a payment using your custom reference. x-groupName: Modifications x-sortIndex: 5 @@ -385,6 +432,7 @@ paths: In your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions. For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request). + operationId: post-voidPendingRefund requestBody: content: application/json: @@ -397,14 +445,16 @@ paths: schema: $ref: '#/components/schemas/ModificationResult' description: OK - the request has succeeded. - "422": - description: Unprocessable Entity - a request validation error. + "400": + description: Bad Request - a problem reading or understanding the request. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Cancels a POS refund request before it has been completed. x-groupName: Modifications x-sortIndex: 7 @@ -571,104 +621,64 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string - AdditionalDataCommon: - properties: - authorisationType: - description: |- - Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/checkout/adjust-authorisation#authorisation-types). - - Allowed values: - * **PreAuth** – flags the payment request to be handled as a pre-authorisation. - * **FinalAuth** – flags the payment request to be handled as a final authorisation. - type: string - customRoutingFlag: - description: |- - Allows you to determine or override the acquirer account that should be used for the transaction. - - If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. - - To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new). - type: string - networkTxReference: - description: |- - Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. - - Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. - - Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. - - Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardonFile** to ensure that the transaction is classified as MIT. - type: string - overwriteBrand: - description: Boolean indicator that can be optionally used for performing - debit transactions on combo cards (for example, combo cards in Brazil). - This is not mandatory but we recommend that you set this to true if you - want to use the `selectedBrand` value to specify how to process the transaction. - type: string - RequestedTestErrorResponseCode: - description: |- - Triggers test scenarios that allow to replicate certain communication errors. - - Allowed values: - * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. - This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. - * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. - This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response. - type: string - subMerchantID: - description: |- - This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID, which is used by schemes to identify the merchant. - - A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. - * Format: alpha-numeric. - * Fixed length: 15 characters. - type: string - AdditionalDataModifications: - properties: - installmentPaymentData.selectedInstallmentOption: - description: This is the installment option selected by the shopper. It - is required only if specified by the user. - type: string AdditionalData3DSecure: properties: allow3DS2: - description: |- - This parameter indicates that you are able to process 3D Secure 2 transactions natively on your payment page. Send this field when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/checkout/3d-secure/native-3ds2), such as Components or Drop-in. Possible values: + description: | + Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/checkout/3d-secure/native-3ds2). + + > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter. + + Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration. - > This parameter only indicates your readiness to support 3D Secure 2 natively on Drop-in or Components. To specify that you want to perform 3D Secure on a transaction, use Dynamic 3D Secure or send the executeThreeD parameter. type: string executeThreeD: - description: |- - This parameter indicates if you want to perform 3D Secure authentication on a transaction or not. Allowed values: + description: | + Indicates if you want to perform 3D Secure authentication on a transaction. + + > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure. + + Possible values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. - > Alternatively, you can also use Dynamic 3D Secure to configure rules for applying 3D Secure. type: string mpiImplementationType: description: In case of Secure+, this field must be set to **CUPSecurePlus**. type: string scaExemption: - description: "Indicates the [exemption type](https://docs-admin.is.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ - \ that you want to request for the transaction. Possible values:\n* **lowValue**\ - \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " + description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ + \ that you want to request for the transaction.\n\n Possible values:\n\ + * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ + \ **transactionRiskAnalysis** " + type: string + threeDSVersion: + description: "Indicates your preference for the 3D Secure version. \n> If\ + \ you use this parameter, you override the checks from Adyen's Authentication\ + \ Engine. We recommend to use this field only if you have an extensive\ + \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ + \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ + \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ + \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ + \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ + \ in the `ARes`, we will apply the fallback policy configured in your\ + \ account. For example, if the configuration is to fall back to 3D Secure\ + \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ + \ the BIN is not enrolled, you will receive an error.\n\n" type: string AdditionalDataAirline: properties: - airline.passenger_name: + airline.agency_invoice_number: description: |- - Passenger name, initials, and a title. - * Format: last name + first name or initials + title. - * Example: *FLYER / MARY MS*. + Reference number for the invoice, issued by the agency. * minLength: 1 - * maxLength: 49 + * maxLength: 6 type: string - airline.computerized_reservation_system: + airline.agency_plan_name: description: |- - The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. - * Format: alphanumeric. - * minLength: 4 - * maxLength: 4 + 2-letter agency plan identifier; alphabetical. + * minLength: 2 + * maxLength: 2 type: string airline.airline_code: description: |- @@ -678,19 +688,27 @@ components: * minLength: 3 * maxLength: 3 type: string - airline.ticket_number: + airline.airline_designator_code: description: |- - The ticket's unique identifier. + [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier. + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code + * Example: KLM = KL + * minLength: 2 + * maxLength: 2 + type: string + airline.boarding_fee: + description: |- + Chargeable amount for boarding the plane. + The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). * minLength: 1 - * maxLength: 150 + * maxLength: 18 type: string - airline.flight_date: + airline.computerized_reservation_system: description: |- - Flight departure date. Local time `(HH:mm)` is optional. - * Date format: `yyyy-MM-dd` - * Date and time format: `yyyy-MM-dd HH:mm` - * minLength: 10 - * maxLength: 16 + The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. + * Format: alphanumeric. + * minLength: 4 + * maxLength: 4 type: string airline.customer_reference_number: description: |- @@ -698,58 +716,46 @@ components: * minLength: 0 * maxLength: 20 type: string - airline.ticket_issue_address: - description: |- - Address of the place/agency that issued the ticket. - * minLength: 0 - * maxLength: 16 - type: string - airline.airline_designator_code: + airline.document_type: description: |- - [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier. - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code - * Example: KLM = KL + Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements. + * Format: 2-digit code + * Example: Passenger ticket = 01 * minLength: 2 * maxLength: 2 type: string - airline.travel_agency_code: + airline.flight_date: description: |- - IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies. - * minLength: 1 - * maxLength: 8 - type: string - airline.travel_agency_name: - description: |- - The name of the travel agency. - * minLength: 1 - * maxLength: 25 + Flight departure date. Local time `(HH:mm)` is optional. + * Date format: `yyyy-MM-dd` + * Date and time format: `yyyy-MM-dd HH:mm` + * minLength: 10 + * maxLength: 16 type: string - airline.agency_plan_name: + airline.leg.carrier_code: description: |- - 2-letter agency plan identifier; alphabetical. + [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier. + This field is required/mandatory if the airline data includes leg details. + * Format: IATA 2-letter airline code + * Example: KLM = KL * minLength: 2 * maxLength: 2 type: string - airline.agency_invoice_number: - description: |- - Reference number for the invoice, issued by the agency. - * minLength: 1 - * maxLength: 6 - type: string - airline.boarding_fee: + airline.leg.class_of_travel: description: |- - Chargeable amount for boarding the plane. - The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + 1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently: + * F: first class + * J: business class + * Y: economy class + * W: premium economy + + Limitations: * minLength: 1 - * maxLength: 18 + * maxLength: 1 type: string - airline.document_type: - description: |- - Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements. - * Format: 2-digit code - * Example: Passenger ticket = 01 - * minLength: 2 - * maxLength: 2 + airline.leg.date_of_travel: + description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ + * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" type: string airline.leg.depart_airport: description: |- @@ -760,20 +766,20 @@ components: * minLength: 3 * maxLength: 3 type: string - airline.leg.flight_number: + airline.leg.depart_tax: description: |- - The flight identifier. + [Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). * minLength: 1 - * maxLength: 5 + * maxLength: 12 type: string - airline.leg.carrier_code: + airline.leg.destination_code: description: |- - [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier. + Alphabetical identifier of the destination/arrival airport. This field is required/mandatory if the airline data includes leg details. - * Format: IATA 2-letter airline code - * Example: KLM = KL - * minLength: 2 - * maxLength: 2 + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. + * Example: Amsterdam = AMS + * minLength: 3 + * maxLength: 3 type: string airline.leg.fare_base_code: description: |- @@ -781,17 +787,11 @@ components: * minLength: 1 * maxLength: 7 type: string - airline.leg.class_of_travel: + airline.leg.flight_number: description: |- - 1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently: - * F: first class - * J: business class - * Y: economy class - * W: premium economy - - Limitations: + The flight identifier. * minLength: 1 - * maxLength: 1 + * maxLength: 5 type: string airline.leg.stop_over_code: description: |- @@ -803,24 +803,13 @@ components: * minLength: 1 * maxLength: 1 type: string - airline.leg.destination_code: - description: |- - Alphabetical identifier of the destination/arrival airport. - This field is required/mandatory if the airline data includes leg details. - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. - * Example: Amsterdam = AMS - * minLength: 3 - * maxLength: 3 - type: string - airline.leg.date_of_travel: - description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ - * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" - type: string - airline.leg.depart_tax: + airline.passenger.date_of_birth: description: |- - [Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). - * minLength: 1 - * maxLength: 12 + Date of birth of the passenger. + + Date format: `yyyy-MM-dd` + * minLength: 10 + * maxLength: 10 type: string airline.passenger.first_name: description: |- @@ -832,6 +821,12 @@ components: Passenger last name/family name. > This field is required/mandatory if the airline data includes passenger details or leg details. type: string + airline.passenger.telephone_number: + description: |- + Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs. + * minLength: 3 + * maxLength: 30 + type: string airline.passenger.traveller_type: description: |- Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS. @@ -840,75 +835,98 @@ components: * minLength: 3 * maxLength: 6 type: string - airline.passenger.telephone_number: + airline.passenger_name: description: |- - Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs. - * minLength: 3 - * maxLength: 30 + Passenger name, initials, and a title. + * Format: last name + first name or initials + title. + * Example: *FLYER / MARY MS*. + * minLength: 1 + * maxLength: 49 type: string - airline.passenger.date_of_birth: + airline.ticket_issue_address: description: |- - Date of birth of the passenger. - - Date format: `yyyy-MM-dd` - * minLength: 10 - * maxLength: 10 + Address of the place/agency that issued the ticket. + * minLength: 0 + * maxLength: 16 + type: string + airline.ticket_number: + description: |- + The ticket's unique identifier. + * minLength: 1 + * maxLength: 150 + type: string + airline.travel_agency_code: + description: |- + IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies. + * minLength: 1 + * maxLength: 8 + type: string + airline.travel_agency_name: + description: |- + The name of the travel agency. + * minLength: 1 + * maxLength: 25 type: string required: - airline.passenger_name AdditionalDataCarRental: properties: - carRental.rentalAgreementNumber: + carRental.checkOutDate: description: |- - The rental agreement number associated with this car rental. - * Format: Alphanumeric - * maxLength: 14 + Pick-up date. + * Date format: `yyyyMMdd` type: string - carRental.renterName: + carRental.customerServiceTollFreeNumber: description: |- - The name of the person renting the car. + The customer service phone number of the car rental company. * Format: Alphanumeric - * maxLength: 26 + * maxLength: 17 type: string - carRental.returnCity: + carRental.daysRented: description: |- - The city where the car must be returned. - * Format: Alphanumeric - * maxLength: 18 + Number of days for which the car is being rented. + * Format: Numeric + * maxLength: 19 type: string - carRental.returnStateProvince: + carRental.fuelCharges: description: |- - The state or province where the car must be returned. - * Format: Alphanumeric - * maxLength: 3 + Any fuel charges associated with the rental. + * Format: Numeric + * maxLength: 12 type: string - carRental.returnCountry: + carRental.insuranceCharges: description: |- - The country where the car must be returned. - * Format: Alphanumeric - * maxLength: 2 + Any insurance charges associated with the rental. + * Format: Numeric + * maxLength: 12 type: string - carRental.returnLocationId: + carRental.locationCity: description: |- - Agency code, phone number, or address abbreviation + The city from which the car is rented. * Format: Alphanumeric - * maxLength: 10 + * maxLength: 18 type: string - carRental.returnDate: + carRental.locationCountry: description: |- - The last date to return the car by. - * Date format: `yyyyMMdd` + The country from which the car is rented. + * Format: Alphanumeric + * maxLength: 2 type: string - carRental.checkOutDate: + carRental.locationStateProvince: description: |- - Pick-up date. - * Date format: `yyyyMMdd` + The state or province from where the car is rented. + * Format: Alphanumeric + * maxLength: 3 type: string - carRental.customerServiceTollFreeNumber: + carRental.noShowIndicator: description: |- - The customer service phone number of the car rental company. - * Format: Alphanumeric - * maxLength: 17 + Indicates if the customer was a "no-show" (neither keeps nor cancels their booking). + * Y - Customer was a no show. + * N - Not applicable. + type: string + carRental.oneWayDropOffCharges: + description: Charge associated with not returning a vehicle to the original + rental location. type: string carRental.rate: description: |- @@ -922,22 +940,11 @@ components: * D - Daily rate. * W - Weekly rate. type: string - carRental.locationCity: - description: |- - The location from which the car is rented. - * Format: Alphanumeric - * maxLength: 18 - type: string - carRental.locationStateProvince: - description: |- - Pick-up date. - * Date format: `yyyyMMdd` - type: string - carRental.locationCountry: + carRental.rentalAgreementNumber: description: |- - The customer service phone number of the car rental company. + The rental agreement number associated with this car rental. * Format: Alphanumeric - * maxLength: 17 + * maxLength: 9 type: string carRental.rentalClassId: description: |- @@ -945,91 +952,196 @@ components: * Format: Alphanumeric * maxLength: 12 type: string - carRental.daysRented: - description: |- - Specifies whether the given rate is applied daily or weekly. - * D - Daily rate. - * W - Weekly rate. - type: string - carRental.taxExemptIndicator: + carRental.renterName: description: |- - Indicates whether the goods or services were tax-exempt, or tax was not collected. - - Values: - * 0 - Tax was not collected - * 1 - Goods or services were tax exempt + The name of the person renting the car. + * Format: Alphanumeric + * maxLength: 26 type: string - travelEntertainmentAuthData.market: + carRental.returnCity: description: |- - Indicates what market-specific dataset will be submitted or is being submitted. Value should be "A" for Car rental. This should be included in the auth message. + The city where the car must be returned. * Format: Alphanumeric - * maxLength: 1 + * maxLength: 18 type: string - travelEntertainmentAuthData.duration: + carRental.returnCountry: description: |- - Number of nights. This should be included in the auth message. - * Format: Numeric + The country where the car must be returned. + * Format: Alphanumeric * maxLength: 2 type: string - carRental.fuelCharges: + carRental.returnDate: description: |- - Any fuel charges associated with the rental. - * Format: Numeric - * maxLength: 12 + The last date to return the car by. + * Date format: `yyyyMMdd` type: string - carRental.insuranceCharges: + carRental.returnLocationId: description: |- - Any insurance charges associated with the rental. + Agency code, phone number, or address abbreviation + * Format: Alphanumeric + * maxLength: 10 + type: string + carRental.returnStateProvince: + description: |- + The state or province where the car must be returned. + * Format: Alphanumeric + * maxLength: 3 + type: string + carRental.taxExemptIndicator: + description: |- + Indicates whether the goods or services were tax-exempt, or tax was not collected. + + Values: + * Y - Goods or services were tax exempt + * N - Tax was not collected + type: string + travelEntertainmentAuthData.duration: + description: |- + Number of nights. This should be included in the auth message. * Format: Numeric - * maxLength: 12 + * maxLength: 2 type: string - carRental.noShowIndicator: + travelEntertainmentAuthData.market: description: |- - Indicates if the customer was a "no-show" (neither keeps nor cancels their booking). - * 0 - Not applicable. - * 1 - Customer was a no show. + Indicates what market-specific dataset will be submitted or is being submitted. Value should be "A" for Car rental. This should be included in the auth message. + * Format: Alphanumeric + * maxLength: 1 type: string - carRental.oneWayDropOffCharges: - description: Charge associated with not returning a vehicle to the original - rental location. + AdditionalDataCommon: + properties: + RequestedTestErrorResponseCode: + description: |- + Triggers test scenarios that allow to replicate certain communication errors. + + Allowed values: + * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. + This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. + * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. + This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response. + type: string + authorisationType: + description: |- + Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/checkout/adjust-authorisation#authorisation-types). + + Allowed values: + * **PreAuth** – flags the payment request to be handled as a pre-authorisation. + * **FinalAuth** – flags the payment request to be handled as a final authorisation. + type: string + customRoutingFlag: + description: |- + Allows you to determine or override the acquirer account that should be used for the transaction. + + If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. + + To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new). + type: string + industryUsage: + description: |- + In case of [asynchronous authorisation adjustment](https://docs.adyen.com/checkout/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made. + + Possible values: + + * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation. + + * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed. + enum: + - NoShow + - DelayedCharge + type: string + networkTxReference: + description: |- + Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. + + Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. + + Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. + + Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT. + type: string + overwriteBrand: + description: Boolean indicator that can be optionally used for performing + debit transactions on combo cards (for example, combo cards in Brazil). + This is not mandatory but we recommend that you set this to true if you + want to use the `selectedBrand` value to specify how to process the transaction. + type: string + subMerchantCity: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. + * Format: alpha-numeric. + * Maximum length: 13 characters. + type: string + subMerchantCountry: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. + * Format: alpha-numeric. + * Fixed length: 3 characters. + type: string + subMerchantID: + description: |- + This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. + + A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. + * Format: alpha-numeric. + * Fixed length: 15 characters. + type: string + subMerchantName: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. + * Format: alpha-numeric. + * Maximum length: 22 characters. + type: string + subMerchantPostalCode: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. + * Format: alpha-numeric. + * Maximum length: 10 characters. + type: string + subMerchantState: + description: |- + This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. + * Format: alpha-numeric. + * Maximum length: 3 characters. + type: string + subMerchantStreet: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. + * Format: alpha-numeric. + * Maximum length: 60 characters. + type: string + subMerchantTaxId: + description: |- + This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. + * Format: alpha-numeric. + * Fixed length: 11 or 14 characters. type: string AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: description: |- Customer code, if supplied by a customer. + Encoding: ASCII. + Max length: 25 characters. - > Required for Level 2 and Level 3 data. - type: string - enhancedSchemeData.totalTaxAmount: - description: |- - Total tax amount, in minor units. - For example, 2000 means USD 20.00. - Max length: 12 characters. > Required for Level 2 and Level 3 data. - type: number - enhancedSchemeData.freightAmount: + type: string + enhancedSchemeData.destinationCountryCode: description: |- - Shipping amount, in minor units. + Destination country code. - For example, 2000 means USD 20.00. - Max length: 12 characters. - type: number - enhancedSchemeData.dutyAmount: - description: |- - Duty amount, in minor units. + Encoding: ASCII. - For example, 2000 means USD 20.00. - Max length: 12 characters. - type: number + Max length: 3 characters. + type: string enhancedSchemeData.destinationPostalCode: description: |- The postal code of a destination address. Encoding: ASCII. + Max length: 10 characters. + > Required for American Express. type: string enhancedSchemeData.destinationStateProvinceCode: @@ -1038,84 +1150,113 @@ components: Encoding: ASCII.Max length: 3 characters. type: string - enhancedSchemeData.shipFromPostalCode: + enhancedSchemeData.dutyAmount: description: |- - The postal code of a "ship-from" address. + Duty amount, in minor units. - Encoding: ASCII. - Max length: 10 characters. - type: string - enhancedSchemeData.destinationCountryCode: - description: |- - Destination country code. + For example, 2000 means USD 20.00. - Encoding: ASCII. - Max length: 3 characters. + Max length: 12 characters. type: string - enhancedSchemeData.orderDate: + enhancedSchemeData.freightAmount: description: |- - Order date. - * Format: `ddMMyy` + Shipping amount, in minor units. - Encoding: ASCII. - Max length: 6 characters. + For example, 2000 means USD 20.00. + + Max length: 12 characters. type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: |- Item commodity code. + Encoding: ASCII. + Max length: 12 characters. type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: |- Item description. + Encoding: ASCII. + Max length: 26 characters. type: string + enhancedSchemeData.itemDetailLine[itemNr].discountAmount: + description: |- + Discount amount, in minor units. + + For example, 2000 means USD 20.00. + + Max length: 12 characters. + type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: |- Product code. + Encoding: ASCII. + Max length: 12 characters. type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: |- Quantity, specified as an integer value. + Value must be greater than 0. + Max length: 12 characters. - type: number + type: string + enhancedSchemeData.itemDetailLine[itemNr].totalAmount: + description: |- + Total amount, in minor units. + + For example, 2000 means USD 20.00. + + Max length: 12 characters. + type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: |- Item unit of measurement. + Encoding: ASCII. + Max length: 3 characters. type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: |- Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). + Max length: 12 characters. - type: number - enhancedSchemeData.itemDetailLine[itemNr].discountAmount: + type: string + enhancedSchemeData.orderDate: description: |- - Discount amount, in minor units. + Order date. + * Format: `ddMMyy` - For example, 2000 means USD 20.00. - Max length: 12 characters. - type: number - enhancedSchemeData.itemDetailLine[itemNr].totalAmount: + Encoding: ASCII. + + Max length: 6 characters. + type: string + enhancedSchemeData.shipFromPostalCode: description: |- - Total amount, in minor units. + The postal code of a "ship-from" address. + + Encoding: ASCII. + + Max length: 10 characters. + type: string + enhancedSchemeData.totalTaxAmount: + description: |- + Total tax amount, in minor units. + For example, 2000 means USD 20.00. + Max length: 12 characters. - type: number + + > Required for Level 2 and Level 3 data. + type: string AdditionalDataLodging: properties: - lodging.customerServiceTollFreeNumber: - description: |- - The toll free phone number for the hotel/lodgings. - * Format: Alphanumeric - * maxLength: 17 - type: string lodging.checkInDate: description: |- The arrival date. @@ -1126,77 +1267,77 @@ components: The departure date. * Date format: `yyyyMMdd` type: string - lodging.folioNumber: + lodging.customerServiceTollFreeNumber: description: |- - Card acceptor’s internal invoice or billing ID reference number. + The toll free phone number for the hotel/lodgings. * Format: Alphanumeric - * maxLength: 25 + * maxLength: 17 type: string - lodging.propertyPhoneNumber: + lodging.fireSafetyActIndicator: description: |- - Identifies specific lodging property location by its local phone number. - * Format: Alphanumeric - * maxLength: 17 + Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'. + * Format: Alphabetic + * maxLength: 1 type: string - lodging.room1.rate: + lodging.folioCashAdvances: description: |- - The rate of the room. + The folio cash advances. * Format: Numeric * maxLength: 12 type: string - lodging.room1.tax: + lodging.folioNumber: description: |- - The total amount of tax to be paid. - * Format: Numeric - * maxLength: 12 + Card acceptor’s internal invoice or billing ID reference number. + * Format: Alphanumeric + * maxLength: 25 type: string - lodging.room1.numberOfNights: + lodging.foodBeverageCharges: description: |- - Total number of nights the room will be rented. + Any charges for food and beverages associated with the booking. * Format: Numeric - * maxLength: 4 + * maxLength: 12 type: string - lodging.fireSafetyActIndicator: + lodging.noShowIndicator: description: |- - Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'. - * Format: Alphabetic + Indicates if the customer was a "no-show" (neither keeps nor cancels their booking). + + Value should be Y or N. + * Format: Numeric * maxLength: 1 type: string - travelEntertainmentAuthData.market: + lodging.prepaidExpenses: description: |- - Indicates what market-specific dataset will be submitted or is being submitted. Value should be "H" for Hotel. This should be included in the auth message. - * Format: Alphanumeric - * maxLength: 1 + Prepaid expenses for the booking. + * Format: Numeric + * maxLength: 12 type: string - travelEntertainmentAuthData.duration: + lodging.propertyPhoneNumber: description: |- - Number of nights. This should be included in the auth message. - * Format: Numeric - * maxLength: 2 + Identifies specific lodging property location by its local phone number. + * Format: Alphanumeric + * maxLength: 17 type: string - lodging.folioCashAdvances: + lodging.room1.numberOfNights: description: |- - The folio cash advances. + Total number of nights the room will be rented. * Format: Numeric - * maxLength: 12 + * maxLength: 4 type: string - lodging.foodBeverageCharges: + lodging.room1.rate: description: |- - Any charges for food and beverages associated with the booking. + The rate of the room. * Format: Numeric * maxLength: 12 type: string - lodging.noShowIndicator: + lodging.room1.tax: description: |- - Indicates if the customer was a "no-show" (neither keeps nor cancels their booking). - - Value should be Y or N. + The total amount of tax to be paid. * Format: Numeric - * maxLength: 1 + * maxLength: 12 type: string - lodging.prepaidExpenses: + lodging.totalRoomTax: description: |- - Prepaid expenses for the booking. + Total room tax amount. * Format: Numeric * maxLength: 12 type: string @@ -1206,20 +1347,27 @@ components: * Format: Numeric * maxLength: 12 type: string - lodging.totalRoomTax: + travelEntertainmentAuthData.duration: description: |- - Total room tax amount. + Number of nights. This should be included in the auth message. * Format: Numeric - * maxLength: 12 + * maxLength: 2 type: string - AdditionalDataOpenInvoice: - properties: - openinvoicedata.numberOfLines: + travelEntertainmentAuthData.market: description: |- - The number of invoice lines included in `openinvoicedata`. + Indicates what market-specific dataset will be submitted or is being submitted. Value should be "H" for Hotel. This should be included in the auth message. - There needs to be at least one line, so `numberOfLines` needs to be at least 1. - type: integer + * Format: Alphanumeric + * maxLength: 1 + type: string + AdditionalDataModifications: + properties: + installmentPaymentData.selectedInstallmentOption: + description: This is the installment option selected by the shopper. It + is required only if specified by the user. + type: string + AdditionalDataOpenInvoice: + properties: openinvoicedata.merchantData: description: |- Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string. @@ -1232,36 +1380,42 @@ components: You can contact Klarna for the format and structure of the string. type: string - openinvoicedata.line[itemNr].currencyCode: + openinvoicedata.numberOfLines: + description: |- + The number of invoice lines included in `openinvoicedata`. + + There needs to be at least one line, so `numberOfLines` needs to be at least 1. + type: string + openinvoicedataLine[itemNr].currencyCode: description: The three-character ISO currency code. type: string - openinvoicedata.line[itemNr].description: + openinvoicedataLine[itemNr].description: description: A text description of the product the invoice line refers to. type: string - openinvoicedata.line[itemNr].itemAmount: + openinvoicedataLine[itemNr].itemAmount: description: |- The price for one item in the invoice line, represented in minor units. The due amount for the item, VAT excluded. - type: integer - openinvoicedata.line[itemNr].itemVatAmount: + type: string + openinvoicedataLine[itemNr].itemId: + description: A unique id for this item. Required for RatePay if the description + of each item is not unique. + type: string + openinvoicedataLine[itemNr].itemVatAmount: description: The VAT due for one item in the invoice line, represented in minor units. - type: integer - openinvoicedata.line[itemNr].itemVatPercentage: + type: string + openinvoicedataLine[itemNr].itemVatPercentage: description: |- The VAT percentage for one item in the invoice line, represented in minor units. For example, 19% VAT is specified as 1900. - type: integer - openinvoicedata.line[itemNr].itemId: - description: A unique id for this item. Required for RatePay if the description - of each item is not unique. type: string - openinvoicedata.line[itemNr].numberOfItems: + openinvoicedataLine[itemNr].numberOfItems: description: The number of units purchased of a specific product. - type: integer - openinvoicedata.line[itemNr].vatCategory: + type: string + openinvoicedataLine[itemNr].vatCategory: description: |- Required for AfterPay. The country-specific VAT category a product falls under. @@ -1270,27 +1424,27 @@ components: * Low * None. type: string + AdditionalDataOpi: + properties: + opi.includeTransToken: + description: |- + Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response. + + You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + type: string AdditionalDataRatepay: properties: ratepay.installmentAmount: description: Amount the customer has to pay each month. - type: integer + type: string + ratepay.interestRate: + description: Interest rate of this installment. + type: string ratepay.lastInstallmentAmount: description: Amount of the last installment. - type: integer - ratepay.interestRate: - description: Interest rate of this installment. Double - type: integer + type: string ratepay.paymentFirstday: description: Calendar day of the first payment. - type: integer - ratepaydata.invoiceId: - description: Identification name or number for the invoice, defined by the - merchant. - type: string - ratepaydata.invoiceDate: - description: Invoice date, defined by the merchant. If not included, the - invoice date is set to the delivery date. type: string ratepaydata.deliveryDate: description: Date the merchant delivered the goods to the customer. @@ -1298,61 +1452,63 @@ components: ratepaydata.dueDate: description: Date by which the customer must settle the payment. type: string + ratepaydata.invoiceDate: + description: Invoice date, defined by the merchant. If not included, the + invoice date is set to the delivery date. + type: string + ratepaydata.invoiceId: + description: Identification name or number for the invoice, defined by the + merchant. + type: string AdditionalDataRetry: properties: retry.chainAttemptNumber: description: |- The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen. + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - type: integer + type: string retry.orderAttemptNumber: description: |- The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively. + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - type: integer + type: string retry.skipRetry: description: |- The Boolean value indicating whether Adyen should skip or retry this transaction, if possible. + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - type: boolean + type: string AdditionalDataRisk: properties: riskdata.[customFieldName]: description: The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). type: string - riskdata.basket.item[itemNr].itemID: - description: ID of the item. - type: string - riskdata.basket.item[itemNr].productTitle: - description: A text description of the product the invoice line refers to. - type: string riskdata.basket.item[itemNr].amountPerItem: description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). type: string - riskdata.basket.item[itemNr].currency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.basket.item[itemNr].upc: - description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' - type: string - riskdata.basket.item[itemNr].sku: - description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' - type: string riskdata.basket.item[itemNr].brand: description: Brand of the item. type: string - riskdata.basket.item[itemNr].manufacturer: - description: Manufacturer of the item. - type: string riskdata.basket.item[itemNr].category: description: Category of the item. type: string riskdata.basket.item[itemNr].color: description: Color of the item. type: string - riskdata.basket.item[itemNr].size: - description: Size of the item. + riskdata.basket.item[itemNr].currency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.basket.item[itemNr].itemID: + description: ID of the item. + type: string + riskdata.basket.item[itemNr].manufacturer: + description: Manufacturer of the item. + type: string + riskdata.basket.item[itemNr].productTitle: + description: A text description of the product the invoice line refers to. type: string riskdata.basket.item[itemNr].quantity: description: Quantity of the item purchased. @@ -1361,12 +1517,18 @@ components: description: Email associated with the given product in the basket (usually in electronic gift cards). type: string + riskdata.basket.item[itemNr].size: + description: Size of the item. + type: string + riskdata.basket.item[itemNr].sku: + description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' + type: string + riskdata.basket.item[itemNr].upc: + description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' + type: string riskdata.promotions.promotion[itemNr].promotionCode: description: Code of the promotion. type: string - riskdata.promotions.promotion[itemNr].promotionName: - description: Name of the promotion. - type: string riskdata.promotions.promotion[itemNr].promotionDiscountAmount: description: The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -1380,8 +1542,43 @@ components: e.g. for a promotion discount of 30%, the value of the field should be 30. type: string + riskdata.promotions.promotion[itemNr].promotionName: + description: Name of the promotion. + type: string AdditionalDataRiskStandalone: properties: + PayPal.CountryCode: + description: Shopper's country of residence in the form of ISO standard + 3166 2-character country codes. + type: string + PayPal.EmailId: + description: Shopper's email. + type: string + PayPal.FirstName: + description: Shopper's first name. + type: string + PayPal.LastName: + description: Shopper's last name. + type: string + PayPal.PayerId: + description: 'Unique PayPal Customer Account identification number. Character + length and limitations: 13 single-byte alphanumeric characters.' + type: string + PayPal.Phone: + description: Shopper's phone number. + type: string + PayPal.ProtectionEligibility: + description: |- + Allowed values: + * **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. + + * **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. + + * **Ineligible** — Merchant is not protected under the Seller Protection Policy. + type: string + PayPal.TransactionId: + description: Unique transaction ID of the payment. + type: string avsResultRaw: description: 'Raw AVS result received from the acquirer, where available. Example: D' @@ -1394,7 +1591,7 @@ components: description: 'Raw CVC result received from the acquirer, where available. Example: 1' type: string - risk.token: + riskToken: description: Unique identifier or token for the shopper's card details. type: string threeDAuthenticated: @@ -1409,36 +1606,6 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string - PayPal.ProtectionEligibility: - description: |- - Allowed values: - * **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. - * **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. - * **Ineligible** — Merchant is not protected under the Seller Protection Policy. - type: string - PayPal.PayerId: - description: 'Unique PayPal Customer Account identification number. Character - length and limitations: 13 single-byte alphanumeric characters.' - type: string - PayPal.TransactionId: - description: Unique transaction ID of the payment. - type: string - PayPal.CountryCode: - description: Shopper's country of residence in the form of ISO standard - 3166 2-character country codes. - type: string - PayPal.FirstName: - description: Shopper's first name. - type: string - PayPal.LastName: - description: Shopper's last name. - type: string - PayPal.Phone: - description: Shopper's phone number. - type: string - PayPal.EmailId: - description: Shopper's email. - type: string AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -1447,11 +1614,6 @@ components: * Encoding: ASCII * maxLength: 25 type: string - enhancedSchemeData.totalTaxAmount: - description: |- - Total tax amount, in minor units. For example, 2000 means USD 20.00 - * maxLength: 12 - type: string enhancedSchemeData.employeeName: description: |- Name or ID associated with the individual working in a temporary capacity. @@ -1462,6 +1624,21 @@ components: Description of the job or task of the individual working in a temporary capacity. * maxLength: 40 type: string + enhancedSchemeData.regularHoursRate: + description: |- + Amount paid per regular hours worked, minor units. + * maxLength: 7 + type: string + enhancedSchemeData.regularHoursWorked: + description: |- + Amount of time worked during a normal operation for the task or job. + * maxLength: 7 + type: string + enhancedSchemeData.requestName: + description: |- + Name of the individual requesting temporary services. + * maxLength: 40 + type: string enhancedSchemeData.tempStartDate: description: |- Date for the beginning of the pay period. @@ -1474,20 +1651,10 @@ components: * Format: ddMMyy * maxLength: 6 type: string - enhancedSchemeData.requestName: + enhancedSchemeData.totalTaxAmount: description: |- - Name of the individual requesting temporary services. - * maxLength: 40 - type: string - enhancedSchemeData.regularHoursWorked: - description: |- - Amount of time worked during a normal operation for the task or job. - * maxLength: 7 - type: string - enhancedSchemeData.regularHoursRate: - description: |- - Amount paid per regular hours worked, minor units. - * maxLength: 7 + Total tax amount, in minor units. For example, 2000 means USD 20.00 + * maxLength: 12 type: string AdditionalDataWallets: properties: @@ -1510,1105 +1677,834 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string - ResponseAdditionalDataCommon: + Address: + example: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode properties: - acquirerAccountCode: - description: |- - The name of the Adyen acquirer account. - - Example: PayPalSandbox_TestAcquirer - > Only relevant for PayPal transactions. + city: + description: The name of the city. type: string - acquirerCode: + country: description: |- - The name of the acquirer processing the payment request. - - Example: TestPmmAcquirer + The two-character country code as defined in ISO-3166-1 alpha-2. For example, **US**. + > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. type: string - acquirerReference: - description: |- - The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. - - Example: 7C9N3FNBKT9 + houseNumberOrName: + description: The number or name of the house. type: string - alias: - description: |- - The Adyen alias of the card. - - Example: H167852639363479 + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. type: string - aliasType: + stateOrProvince: description: |- - The type of the card alias. - - Example: Default + State or province codes as defined in ISO 3166-2. For example, **CA** in the US or **ON** in Canada. + > Required for the US and Canada. type: string - authCode: + street: description: |- - Authorisation code: - * When the payment is authorised successfully, this field holds the authorisation code for the payment. - * When the payment is not authorised, this field is empty. - - Example: 58747 + The name of the street. + > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. type: string - authorisedAmountCurrency: - description: The currency of the authorised amount, as a three-character - [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + required: + - city + - country + - houseNumberOrName + - postalCode + - street + Amount: + example: + currency: currency + value: 0 + properties: + currency: + description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + maxLength: 3 + minLength: 3 type: string - authorisedAmountValue: - description: |- - Value of the amount authorised. - - This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + value: + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + format: int64 + type: integer + required: + - currency + - value + ApplicationInfo: + example: + adyenLibrary: + name: name + version: version + merchantApplication: + name: name + version: version + adyenPaymentSource: + name: name + version: version + merchantDevice: + reference: reference + os: os + osVersion: osVersion + shopperInteractionDevice: + os: os + osVersion: osVersion + locale: locale + externalPlatform: + name: name + integrator: integrator + version: version + properties: + adyenLibrary: + $ref: '#/components/schemas/CommonField' + adyenPaymentSource: + $ref: '#/components/schemas/CommonField' + externalPlatform: + $ref: '#/components/schemas/ExternalPlatform' + merchantApplication: + $ref: '#/components/schemas/CommonField' + merchantDevice: + $ref: '#/components/schemas/MerchantDevice' + shopperInteractionDevice: + $ref: '#/components/schemas/ShopperInteractionDevice' + AuthenticationResultRequest: + example: + merchantAccount: merchantAccount + pspReference: pspReference + properties: + merchantAccount: + description: The merchant account identifier, with which the authentication + was processed. type: string - avsResult: - description: |- - The AVS result code of the payment, which provides information about the outcome of the AVS check. - - For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs). + pspReference: + description: The pspReference identifier for the transaction. type: string - avsResultRaw: - description: |- - Raw AVS result received from the acquirer, where available. - - Example: D + required: + - merchantAccount + - pspReference + AuthenticationResultResponse: + example: + threeDS2Result: + whiteListStatus: whiteListStatus + cavvAlgorithm: cavvAlgorithm + dsTransID: dsTransID + transStatusReason: transStatusReason + eci: eci + messageVersion: messageVersion + authenticationValue: authenticationValue + transStatus: transStatus + threeDSServerTransID: threeDSServerTransID + timestamp: timestamp + threeDS1Result: + cavv: cavv + xid: xid + cavvAlgorithm: cavvAlgorithm + threeDAuthenticatedResponse: threeDAuthenticatedResponse + eci: eci + threeDOfferedResponse: threeDOfferedResponse + properties: + threeDS1Result: + $ref: '#/components/schemas/ThreeDS1Result' + threeDS2Result: + $ref: '#/components/schemas/ThreeDS2Result' + BankAccount: + example: + ownerName: ownerName + countryCode: countryCode + taxId: taxId + iban: iban + bankAccountNumber: bankAccountNumber + bankName: bankName + bankLocationId: bankLocationId + bic: bic + bankCity: bankCity + properties: + bankAccountNumber: + description: The bank account number (without separators). type: string - bic: - description: |- - BIC of a bank account. - - Example: TESTNL01 - > Only relevant for SEPA Direct Debit transactions. + bankCity: + description: The bank city. type: string - dsTransID: - description: Supported for 3D Secure 2. The unique transaction identifier - assigned by the DS to identify a single transaction. + bankLocationId: + description: The location id of the bank. The field value is `nil` in most + cases. type: string - eci: - description: |- - The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. - - Example: 02 + bankName: + description: The name of the bank. type: string - expiryDate: - description: |- - The expiry date on the card. - - Example: 6/2016 - > Returned only in case of a card payment. + bic: + description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) + (BIC) is the SWIFT address assigned to a bank. The field value is `nil` + in most cases. type: string - extraCostsCurrency: + countryCode: description: |- - The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. + Country code where the bank is located. - Example: EUR - type: string - extraCostsValue: - description: The value of the extra amount charged due to additional amounts - set in the skin used in the HPP payment request. The amount is in minor - units. + A valid value is an ISO two-character country code (e.g. 'NL'). type: string - fraudCheck-[itemNr]-[FraudCheckname]: - description: The fraud score due to a particular fraud check. The fraud - check name is found in the key of the key-value pair. + iban: + description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) + (IBAN). type: string - fundingSource: + ownerName: description: |- - Information regarding the funding type of the card. The possible return values are: - * CHARGE - * CREDIT - * DEBIT - * PREPAID - * PREPAID_RELOADABLE - * PREPAID_NONRELOADABLE - * DEFFERED_DEBIT - > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. - - For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. - type: string - fundsAvailability: - description: |- - Indicates availability of funds. - - Visa: - * "I" (fast funds are supported) - * "N" (otherwise) - - Mastercard: - * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) - * "N" (otherwise) - - > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is "Y" or "D". + The name of the bank account holder. + If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: + * χ12 is converted to ch12. + * üA is converted to euA. + * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. + After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: + * John17 - allowed. + * J17 - allowed. + * 171 - not allowed. + * John-7 - allowed. + > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. type: string - inferredRefusalReason: - description: |- - Provides the more granular indication of why a transaction was refused. When a transaction fails with either "Refused", "Restricted Card", "Transaction Not Permitted", "Not supported" or "DeclinedNon Generic" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to "Not Supported". - - Possible values: - * 3D Secure Mandated - * Closed Account - * ContAuth Not Supported - * CVC Mandated - * Ecommerce Not Allowed - * Crossborder Not Supported - * Card Updated - * Low Authrate Bin - * Non-reloadable prepaid card + taxId: + description: The bank account holder's tax ID. type: string - issuerCountry: - description: |- - The issuing country of the card based on the BIN list that Adyen maintains. - - Example: JP + BrowserInfo: + example: + acceptHeader: acceptHeader + screenWidth: 7 + javaEnabled: true + screenHeight: 2 + timeZoneOffset: 9 + javaScriptEnabled: true + language: language + userAgent: userAgent + colorDepth: 5 + properties: + acceptHeader: + description: The accept header value of the shopper's browser. + maxLength: 50 + minLength: 10 type: string - mcBankNetReferenceNumber: - description: |- - The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. - > Contact Support Team to enable this field. + colorDepth: + description: 'The color depth of the shopper''s browser in bits per pixel. + This should be obtained by using the browser''s `screen.colorDepth` property. + Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' + format: int32 + type: integer + javaEnabled: + description: Boolean value indicating if the shopper's browser is able to + execute Java. + type: boolean + javaScriptEnabled: + default: true + description: Boolean value indicating if the shopper's browser is able to + execute JavaScript. A default 'true' value is assumed if the field is + not present. + type: boolean + language: + description: The `navigator.language` value of the shopper's browser (as + defined in IETF BCP 47). type: string - networkTxReference: - description: |- - Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. - - This contains either the Mastercard Trace ID or the Visa Transaction ID. + screenHeight: + description: The total height of the shopper's device screen in pixels. + format: int32 + type: integer + screenWidth: + description: The total width of the shopper's device screen in pixels. + format: int32 + type: integer + timeZoneOffset: + description: Time difference between UTC time and the shopper's browser + local time, in minutes. + format: int32 + type: integer + userAgent: + description: The user agent value of the shopper's browser. + maxLength: 50 + minLength: 10 type: string - ownerName: + required: + - acceptHeader + - colorDepth + - javaEnabled + - language + - screenHeight + - screenWidth + - timeZoneOffset + - userAgent + Card: + example: + cvc: cvc + number: number + holderName: holderName + startMonth: startMonth + issueNumber: issueNumber + expiryMonth: expiryMonth + startYear: startYear + expiryYear: expiryYear + properties: + cvc: description: |- - The owner name of a bank account. - - Only relevant for SEPA Direct Debit transactions. - type: string - paymentAccountReference: - description: The Payment Account Reference (PAR) value links a network token - with the underlying primary account number (PAN). The PAR value consists - of 29 uppercase alphanumeric characters. + The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: + * CVV2/CVC2 – length: 3 digits + * CID – length: 4 digits + > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. + > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). + > When this value is returned in a response, it is always empty because it is not stored. + maxLength: 20 + minLength: 1 type: string - paymentMethodVariant: + expiryMonth: description: |- - The Adyen sub-variant of the payment method used for the payment request. - - For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). - - Example: mcpro + The card expiry month. + Format: 2 digits, zero-padded for single digits. For example: + * 03 = March + * 11 = November + maxLength: 2 + minLength: 1 type: string - payoutEligible: + expiryYear: description: |- - Indicates whether a payout is eligible or not for this card. - - Visa: - * "Y" - * "N" - - Mastercard: - * "Y" (domestic and cross-border) - * "D" (only domestic) - * "N" (no MoneySend) - * "U" (unknown) + The card expiry year. + Format: 4 digits. For example: 2020 + maxLength: 4 + minLength: 4 type: string - realtimeAccountUpdaterStatus: - description: |- - The response code from the Real Time Account Updater service. - - Possible return values are: - * CardChanged - * CardExpiryChanged - * CloseAccount - * ContactCardAccountHolder + holderName: + description: The name of the cardholder, as printed on the card. + maxLength: 50 + minLength: 1 type: string - receiptFreeText: - description: Message to be displayed on the terminal. + issueNumber: + description: The issue number of the card (for some UK debit cards only). + maxLength: 2 + minLength: 1 type: string - recurring.firstPspReference: + number: description: |- - The `pspReference`, of the first recurring payment that created the recurring detail. - - This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. + The card number (4-19 characters). Do not use any separators. + When this value is returned in a response, only the last 4 digits of the card number are returned. + maxLength: 19 + minLength: 4 type: string - recurring.recurringDetailReference: - description: The reference that uniquely identifies the recurring transaction. + startMonth: + description: The month component of the start date (for some UK debit cards + only). + maxLength: 2 + minLength: 1 type: string - referred: - description: |- - If the payment is referred, this field is set to true. - - This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. - - Example: true + startYear: + description: The year component of the start date (for some UK debit cards + only). + maxLength: 4 + minLength: 4 type: string - refusalReasonRaw: - description: |- - Raw refusal reason received from the acquirer, where available. - - Example: AUTHORISED + required: + - expiryMonth + - expiryYear + - holderName + - number + CommonField: + example: + name: name + version: version + properties: + name: + description: Name of the field. For example, Name of External Platform. type: string - shopperInteraction: - description: |- - The shopper interaction type of the payment request. - - Example: Ecommerce + version: + description: Version of the field. For example, Version of External Platform. type: string - shopperReference: + DeviceRenderOptions: + example: + sdkUiType: + - multiSelect + - multiSelect + sdkInterface: both + properties: + sdkInterface: + default: both description: |- - The shopperReference passed in the payment request. - - Example: AdyenTestShopperXX - type: string - terminalId: - description: |- - The terminal ID used in a point-of-sale payment. - - Example: 06022622 + Supported SDK interface types. + Allowed values: + * native + * html + * both + enum: + - native + - html + - both type: string - threeDAuthenticated: + sdkUiType: description: |- - A Boolean value indicating whether 3DS authentication was completed on this payment. - - Example: true + UI types supported for displaying specific challenges. + Allowed values: + * text + * singleSelect + * outOfBand + * otherHtml + * multiSelect + items: + enum: + - multiSelect + - otherHtml + - outOfBand + - singleSelect + - text + type: string + type: array + DonationRequest: + example: + originalReference: originalReference + reference: reference + merchantAccount: merchantAccount + modificationAmount: + currency: currency + value: 0 + donationAccount: donationAccount + properties: + donationAccount: + description: The Adyen account name of the charity. type: string - threeDAuthenticatedResponse: - description: |- - The raw 3DS authentication result from the card issuer. - - Example: N + merchantAccount: + description: The merchant account that is used to process the payment. type: string - threeDOffered: + modificationAmount: + $ref: '#/components/schemas/Amount' + originalReference: description: |- - A Boolean value indicating whether 3DS was offered for this payment. - - Example: true + The original pspReference of the payment to modify. + This reference is returned in: + * authorisation response + * authorisation notification type: string - threeDOfferedResponse: + reference: description: |- - The raw enrollment result from the 3DS directory services of the card schemes. - - Example: Y + Optionally, you can specify your reference for the payment modification. This reference is visible in Customer Area and in reports. + Maximum length: 80 characters. type: string - threeDSVersion: - description: The 3D Secure 2 version. + required: + - donationAccount + - merchantAccount + - originalReference + ExternalPlatform: + example: + name: name + integrator: integrator + version: version + properties: + integrator: + description: External platform integrator. type: string - visaTransactionId: - description: |- - The `visaTransactionId`, has a fixed length of 15 numeric characters. - > Contact Support Team to enable this field. + name: + description: Name of the field. For example, Name of External Platform. type: string - xid: - description: |- - The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. - - Example: ODgxNDc2MDg2MDExODk5MAAAAAA= + version: + description: Version of the field. For example, Version of External Platform. type: string - ResponseAdditionalDataBillingAddress: + ForexQuote: + example: + reference: reference + validTill: 2000-01-23T04:56:07.000+00:00 + signature: signature + accountType: accountType + buy: + currency: currency + value: 0 + sell: + currency: currency + value: 0 + interbank: + currency: currency + value: 0 + source: source + type: type + basePoints: 2 + account: account + baseAmount: + currency: currency + value: 0 properties: - billingAddress.city: - description: The billing address city passed in the payment request. + account: + description: The account name. type: string - billingAddress.country: - description: |- - The billing address country passed in the payment request. - - Example: NL + accountType: + description: The account type. type: string - billingAddress.houseNumberOrName: - description: The billing address house number or name passed in the payment - request. + baseAmount: + $ref: '#/components/schemas/Amount' + basePoints: + description: The base points. + format: int32 + type: integer + buy: + $ref: '#/components/schemas/Amount' + interbank: + $ref: '#/components/schemas/Amount' + reference: + description: The reference assigned to the forex quote request. type: string - billingAddress.postalCode: - description: |- - The billing address postal code passed in the payment request. - - Example: 1011 DJ + sell: + $ref: '#/components/schemas/Amount' + signature: + description: The signature to validate the integrity. type: string - billingAddress.stateOrProvince: - description: |- - The billing address state or province passed in the payment request. - - Example: NH + source: + description: The source of the forex quote. type: string - billingAddress.street: - description: The billing address street passed in the payment request. + type: + description: The type of forex. type: string - ResponseAdditionalDataCard: + validTill: + description: The date until which the forex quote is valid. + format: date-time + type: string + required: + - basePoints + - validTill + FraudCheckResult: + example: + accountScore: 6 + name: name + checkId: 1 properties: - cardBin: + accountScore: + description: The fraud score generated by the risk check. + format: int32 + type: integer + checkId: + description: The ID of the risk check. + format: int32 + type: integer + name: + description: The name of the risk check. + type: string + required: + - accountScore + - checkId + - name + FraudResult: + example: + accountScore: 0 + results: + - accountScore: 6 + name: name + checkId: 1 + - accountScore: 6 + name: name + checkId: 1 + properties: + accountScore: + description: The total fraud score generated by the risk checks. + format: int32 + type: integer + results: + description: The result of the individual risk checks. + items: + $ref: '#/components/schemas/FraudCheckResult' + type: array + required: + - accountScore + Installments: + example: + plan: regular + value: 7 + properties: + plan: description: |- - The Bank Identification Number of a credit card, which is the first six digits of a card number. + Defines the type of installment plan. If not set, defaults to **regular**. - Example: 521234 - type: string - cardHolderName: - description: The cardholder name passed in the payment request. - type: string - cardIssuingBank: - description: The bank or the financial institution granting lines of credit - through card association branded payment cards. This information can be - included when available. + Possible values: + * **regular** + * **revolving** + enum: + - regular + - revolving type: string - cardIssuingCountry: + value: description: |- - The country where the card was issued. + Defines the number of installments. Its value needs to be greater than zero. - Example: US + Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. + format: int32 + type: integer + required: + - value + MerchantDevice: + example: + reference: reference + os: os + osVersion: osVersion + properties: + os: + description: Operating system running on the merchant device. type: string - cardIssuingCurrency: - description: "The currency in which the card is issued, if this information\ - \ is available. Provided as the currency code or currency number from\ - \ the ISO-4217 standard. \n\nExample: USD" + osVersion: + description: Version of the operating system on the merchant device. type: string - cardPaymentMethod: - description: |- - The card payment method used for the transaction. - - Example: amex + reference: + description: Merchant device reference. type: string - cardSummary: - description: |- - The last four digits of a card number. - > Returned only in case of a card payment. - type: string - ResponseAdditionalDataDeliveryAddress: + MerchantRiskIndicator: + example: + deliveryTimeframe: electronicDelivery + reorderItems: true + preOrderPurchase: true + preOrderDate: 2000-01-23T04:56:07.000+00:00 + giftCardAmount: + currency: currency + value: 0 + deliveryEmail: deliveryEmail + giftCardCount: 1 + addressMatch: true + deliveryAddressIndicator: shipToBillingAddress properties: - deliveryAddress.city: - description: The delivery address city passed in the payment request. - type: string - deliveryAddress.country: + addressMatch: + description: Whether the chosen delivery address is identical to the billing + address. + type: boolean + deliveryAddressIndicator: description: |- - The delivery address country passed in the payment request. - - Example: NL - type: string - deliveryAddress.houseNumberOrName: - description: The delivery address house number or name passed in the payment - request. + Indicator regarding the delivery address. + Allowed values: + * `shipToBillingAddress` + * `shipToVerifiedAddress` + * `shipToNewAddress` + * `shipToStore` + * `digitalGoods` + * `goodsNotShipped` + * `other` + enum: + - shipToBillingAddress + - shipToVerifiedAddress + - shipToNewAddress + - shipToStore + - digitalGoods + - goodsNotShipped + - other type: string - deliveryAddress.postalCode: - description: |- - The delivery address postal code passed in the payment request. - - Example: 1011 DJ + deliveryEmail: + description: The delivery email address (for digital goods). type: string - deliveryAddress.stateOrProvince: + deliveryTimeframe: description: |- - The delivery address state or province passed in the payment request. - - Example: NH + The estimated delivery time for the shopper to receive the goods. + Allowed values: + * `electronicDelivery` + * `sameDayShipping` + * `overnightShipping` + * `twoOrMoreDaysShipping` + enum: + - electronicDelivery + - sameDayShipping + - overnightShipping + - twoOrMoreDaysShipping type: string - deliveryAddress.street: - description: The delivery address street passed in the payment request. + giftCardAmount: + $ref: '#/components/schemas/Amount' + giftCardCount: + description: For prepaid or gift card purchase, total count of individual + prepaid or gift cards/codes purchased. + format: int32 + type: integer + preOrderDate: + description: For pre-order purchases, the expected date this product will + be available to the shopper. + format: date-time type: string - ResponseAdditionalDataInstallments: + preOrderPurchase: + description: Indicator for whether this transaction is for pre-ordering + a product. + type: boolean + reorderItems: + description: Indicator for whether the shopper has already purchased the + same items in the past. + type: boolean + ModificationRequest: + example: + originalReference: originalReference + reference: reference + uniqueTerminalId: uniqueTerminalId + splits: + - reference: reference + amount: + currency: currency + value: 6 + description: description + type: BalanceAccount + account: account + - reference: reference + amount: + currency: currency + value: 6 + description: description + type: BalanceAccount + account: account + merchantAccount: merchantAccount + modificationAmount: + currency: currency + value: 0 + additionalData: "" + tenderReference: tenderReference + mpiData: + cavv: cavv + authenticationResponse: "Y" + xid: xid + cavvAlgorithm: cavvAlgorithm + dsTransID: dsTransID + directoryResponse: A + eci: eci + threeDSVersion: threeDSVersion + originalMerchantReference: originalMerchantReference properties: - installments.value: + additionalData: + anyOf: + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + - $ref: '#/components/schemas/AdditionalDataModifications' description: |- - The number of installments that the payment amount should be charged with. + This field contains additional data, which may be required for a particular modification request. - Example: 5 - > Only relevant for card payments in countries that support installments. + The additionalData object consists of entries, each of which includes the key and value. + merchantAccount: + description: The merchant account that is used to process the payment. type: string - installmentPaymentData.installmentType: - description: Type of installment. The value of `installmentType` should - be **IssuerFinanced**. + modificationAmount: + $ref: '#/components/schemas/Amount' + mpiData: + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + description: The original merchant reference to cancel. type: string - installmentPaymentData.paymentOptions: + originalReference: description: |- - Possible values: - * PayInInstallmentsOnly - * PayInFullOnly - * PayInFullOrInstallments - type: string - installmentPaymentData.option[itemNr].numberOfInstallments: - description: Total number of installments possible for this payment. - type: string - installmentPaymentData.option[itemNr].interestRate: - description: Interest rate for the installment period. - type: string - installmentPaymentData.option[itemNr].installmentFee: - description: Installment fee amount in minor units. - type: string - installmentPaymentData.option[itemNr].annualPercentageRate: - description: Annual interest rate. + The original pspReference of the payment to modify. + This reference is returned in: + * authorisation response + * authorisation notification type: string - installmentPaymentData.option[itemNr].firstInstallmentAmount: - description: First Installment Amount in minor units. + reference: + description: |- + Optionally, you can specify your reference for the payment modification. This reference is visible in Customer Area and in reports. + Maximum length: 80 characters. type: string - installmentPaymentData.option[itemNr].subsequentInstallmentAmount: - description: Subsequent Installment Amount in minor units. + splits: + description: Information on how the payment should be split between accounts + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + description: The transaction reference provided by the PED. For point-of-sale + integrations only. type: string - installmentPaymentData.option[itemNr].minimumNumberOfInstallments: - description: Minimum number of installments possible for this payment. + uniqueTerminalId: + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. type: string - installmentPaymentData.option[itemNr].maximumNumberOfInstallments: - description: Maximum number of installments possible for this payment. + required: + - merchantAccount + - originalReference + ModificationResult: + example: + response: '[capture-received]' + additionalData: + key: additionalData + pspReference: pspReference + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular modification response. + type: object + pspReference: + description: Adyen's 16-character string reference associated with the transaction/request. + This value is globally unique; quote it when communicating with us about + this request. type: string - installmentPaymentData.option[itemNr].totalAmountDue: - description: Total amount in minor units. + response: + description: Indicates if the modification request has been received for + processing. + enum: + - '[capture-received]' + - '[cancel-received]' + - '[refund-received]' + - '[cancelOrRefund-received]' + - '[adjustAuthorisation-received]' + - '[donation-received]' + - '[technical-cancel-received]' + - '[voidPendingRefund-received]' type: string - ResponseAdditionalDataNetworkTokens: + Name: + example: + firstName: firstName + lastName: lastName + gender: MALE + infix: infix properties: - networkToken.available: - description: Indicates whether a network token is available for the specified - card. - type: string - networkToken.bin: - description: The Bank Identification Number of a tokenized card, which is - the first six digits of a card number. + firstName: + description: The first name. type: string - networkToken.tokenSummary: - description: The last four digits of a card number. - type: string - ResponseAdditionalDataPayPal: - properties: - paypalPayerStatus: - description: |- - The status of the buyer's PayPal account. - - Example: unverified - type: string - paypalPayerResidenceCountry: - description: |- - The buyer's country of residence. - - Example: NL - type: string - paypalPayerId: - description: |- - The buyer's PayPal ID. - - Example: LF5HCWWBRV2KL - type: string - paypalEmail: - description: |- - The buyer's PayPal account email address. - - Example: paypaltest@adyen.com - type: string - paypalProtectionEligibility: - description: |- - The eligibility for PayPal Seller Protection for this payment. - - Example: Ineligible - type: string - ResponseAdditionalDataSepa: - properties: - sepadirectdebit.dateOfSignature: - description: |- - The transaction signature date. - - Format: yyyy-MM-dd - type: string - sepadirectdebit.mandateId: - description: Its value corresponds to the pspReference value of the transaction. - type: string - sepadirectdebit.sequenceType: - description: |- - This field can take one of the following values: - * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. - * First: (FRST) Initial/first collection in a series of direct debit instructions. - * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. - * Final: (FNAL) Last/final collection in a series of direct debit instructions. - - Example: OOFF - type: string - Address: - example: - country: country - stateOrProvince: stateOrProvince - city: city - houseNumberOrName: houseNumberOrName - street: street - postalCode: postalCode - properties: - city: - description: The name of the city. - type: string - country: - description: |- - The two-character country code as defined in ISO-3166-1 alpha-2. For example, **US**. - > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. - type: string - houseNumberOrName: - description: The number or name of the house. - type: string - postalCode: - description: A maximum of five digits for an address in the US, or a maximum - of ten characters for an address in all other countries. - type: string - stateOrProvince: + gender: description: |- - State or province codes as defined in ISO 3166-2. For example, **CA** in the US or **ON** in Canada. - > Required for the US and Canada. + The gender. + >The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`. + enum: + - MALE + - FEMALE + - UNKNOWN + maxLength: 1 + minLength: 1 type: string - street: + infix: description: |- - The name of the street. - > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. + The name's infix, if applicable. + >A maximum length of twenty (20) characters is imposed. type: string - required: - - city - - country - - houseNumberOrName - - postalCode - - street - Amount: - example: - currency: currency - value: 0 - properties: - currency: - description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - maxLength: 3 - minLength: 3 + lastName: + description: The last name. type: string - value: - description: |- - The payable amount that can be charged for the transaction. - - The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). - format: int64 - type: integer required: - - currency - - value - ApplicationInfo: + - firstName + - gender + - lastName + PaymentRequest: example: - adyenLibrary: - name: name - version: version - merchantApplication: - name: name - version: version - adyenPaymentSource: - name: name - version: version - merchantDevice: + dccQuote: reference: reference - os: os - osVersion: osVersion - shopperInteractionDevice: - os: os - osVersion: osVersion - locale: locale - externalPlatform: - name: name - integrator: integrator - version: version - properties: - adyenLibrary: - $ref: '#/components/schemas/CommonField' - adyenPaymentSource: - $ref: '#/components/schemas/CommonField' - externalPlatform: - $ref: '#/components/schemas/ExternalPlatform' - merchantApplication: - $ref: '#/components/schemas/CommonField' - merchantDevice: - $ref: '#/components/schemas/MerchantDevice' - shopperInteractionDevice: - $ref: '#/components/schemas/ShopperInteractionDevice' - AuthenticationResultRequest: - example: - merchantAccount: merchantAccount - pspReference: pspReference - properties: - merchantAccount: - description: The merchant account identifier, with which the authentication - was processed. - type: string - pspReference: - description: The pspReference identifier for the transaction. - type: string - required: - - merchantAccount - - pspReference - AuthenticationResultResponse: - example: - threeDS2Result: - whiteListStatus: whiteListStatus - cavvAlgorithm: cavvAlgorithm - dsTransID: dsTransID - transStatusReason: transStatusReason - eci: eci - messageVersion: messageVersion - authenticationValue: authenticationValue - transStatus: transStatus - threeDSServerTransID: threeDSServerTransID - timestamp: timestamp - threeDS1Result: - cavv: cavv - xid: xid - cavvAlgorithm: cavvAlgorithm - threeDAuthenticatedResponse: threeDAuthenticatedResponse - eci: eci - threeDOfferedResponse: threeDOfferedResponse - properties: - threeDS1Result: - $ref: '#/components/schemas/ThreeDS1Result' - threeDS2Result: - $ref: '#/components/schemas/ThreeDS2Result' - BankAccount: - example: - ownerName: ownerName - countryCode: countryCode - taxId: taxId - iban: iban - bankAccountNumber: bankAccountNumber - bankName: bankName - bankLocationId: bankLocationId - bic: bic - bankCity: bankCity - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankCity: - description: The bank city. - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - bankName: - description: The name of the bank. - type: string - bic: - description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) - (BIC) is the SWIFT address assigned to a bank. The field value is `nil` - in most cases. - type: string - countryCode: - description: |- - Country code where the bank is located. - - A valid value is an ISO two-character country code (e.g. 'NL'). - type: string - iban: - description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) - (IBAN). - type: string - ownerName: - description: |- - The name of the bank account holder. - If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: - * χ12 is converted to ch12. - * üA is converted to euA. - * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. - After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: - * John17 - allowed. - * J17 - allowed. - * 171 - not allowed. - * John-7 - allowed. - > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. - type: string - taxId: - description: The bank account holder's tax ID. - type: string - BrowserInfo: - example: - acceptHeader: acceptHeader - screenWidth: 7 - javaEnabled: true - screenHeight: 2 - timeZoneOffset: 9 - javaScriptEnabled: true - language: language - userAgent: userAgent - colorDepth: 5 - properties: - acceptHeader: - description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - colorDepth: - description: 'The color depth of the shopper''s browser in bits per pixel. - This should be obtained by using the browser''s `screen.colorDepth` property. - Accepted values: 1, 4, 8, 15, 16, 24, 32 or 48 bit color depth.' - format: int32 - type: integer - javaEnabled: - description: Boolean value indicating if the shopper's browser is able to - execute Java. - type: boolean - javaScriptEnabled: - description: Boolean value indicating if the shopper's browser is able to - execute JavaScript. A default 'true' value is assumed if the field is - not present. - type: boolean - language: - description: The `navigator.language` value of the shopper's browser (as - defined in IETF BCP 47). - type: string - screenHeight: - description: The total height of the shopper's device screen in pixels. - format: int32 - type: integer - screenWidth: - description: The total width of the shopper's device screen in pixels. - format: int32 - type: integer - timeZoneOffset: - description: Time difference between UTC time and the shopper's browser - local time, in minutes. - format: int32 - type: integer - userAgent: - description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - required: - - acceptHeader - - colorDepth - - javaEnabled - - language - - screenHeight - - screenWidth - - timeZoneOffset - - userAgent - Card: - example: - cvc: cvc - number: number - holderName: holderName - startMonth: startMonth - issueNumber: issueNumber - expiryMonth: expiryMonth - startYear: startYear - expiryYear: expiryYear - properties: - cvc: - description: |- - The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: - * CVV2/CVC2 – length: 3 digits - * CID – length: 4 digits - > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. - > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). - > When this value is returned in a response, it is always empty because it is not stored. - maxLength: 20 - minLength: 1 - type: string - expiryMonth: - description: |- - The card expiry month. - Format: 2 digits, zero-padded for single digits. For example: - * 03 = March - * 11 = November - maxLength: 2 - minLength: 1 - type: string - expiryYear: - description: |- - The card expiry year. - Format: 4 digits. For example: 2020 - maxLength: 4 - minLength: 4 - type: string - holderName: - description: The name of the cardholder, as printed on the card. - maxLength: 50 - minLength: 1 - type: string - issueNumber: - description: The issue number of the card (for some UK debit cards only). - maxLength: 2 - minLength: 1 - type: string - number: - description: |- - The card number (4-19 characters). Do not use any separators. - When this value is returned in a response, only the last 4 digits of the card number are returned. - maxLength: 19 - minLength: 4 - type: string - startMonth: - description: The month component of the start date (for some UK debit cards - only). - maxLength: 2 - minLength: 1 - type: string - startYear: - description: The year component of the start date (for some UK debit cards - only). - maxLength: 4 - minLength: 4 - type: string - required: - - expiryMonth - - expiryYear - - holderName - - number - CommonField: - example: - name: name - version: version - properties: - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - DeviceRenderOptions: - example: - sdkUiType: - - multiSelect - - multiSelect - sdkInterface: Html - properties: - sdkInterface: - description: |- - Supported SDK interface types. - Allowed values: - * Native - * Html - * both - enum: - - Html - - Native - - both - type: string - sdkUiType: - description: |- - UI types supported for displaying specific challenges. - Allowed values: - * text - * singleSelect - * outOfBand - * otherHtml - * multiSelect - items: - enum: - - multiSelect - - otherHtml - - outOfBand - - singleSelect - - text - type: string - type: array - ExternalPlatform: - example: - name: name - integrator: integrator - version: version - properties: - integrator: - description: External platform integrator. - type: string - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - ForexQuote: - example: - reference: reference - validTill: 2000-01-23T04:56:07.000+00:00 - signature: signature - accountType: accountType - buy: - currency: currency - value: 0 - sell: - currency: currency - value: 0 - interbank: - currency: currency - value: 0 - source: source - type: type - basePoints: 2 - account: account - baseAmount: - currency: currency - value: 0 - properties: - account: - description: The account name. - type: string - accountType: - description: The account type. - type: string - baseAmount: - $ref: '#/components/schemas/Amount' - basePoints: - description: The base points. - format: int32 - type: integer - buy: - $ref: '#/components/schemas/Amount' - interbank: - $ref: '#/components/schemas/Amount' - reference: - description: The reference assigned to the forex quote request. - type: string - sell: - $ref: '#/components/schemas/Amount' - signature: - description: The signature to validate the integrity. - type: string - source: - description: The source of the forex quote. - type: string - type: - description: The type of forex. - type: string - validTill: - description: The date until which the forex quote is valid. - format: date-time - type: string - required: - - basePoints - - validTill - FraudCheckResult: - example: - accountScore: 6 - name: name - checkId: 1 - properties: - accountScore: - description: The fraud score generated by the risk check. - format: int32 - type: integer - checkId: - description: The ID of the risk check. - format: int32 - type: integer - name: - description: The name of the risk check. - type: string - required: - - accountScore - - checkId - - name - FraudResult: - example: - accountScore: 0 - results: - - accountScore: 6 - name: name - checkId: 1 - - accountScore: 6 - name: name - checkId: 1 - properties: - accountScore: - description: The total fraud score generated by the risk checks. - format: int32 - type: integer - results: - description: The result of the individual risk checks. - items: - $ref: '#/components/schemas/FraudCheckResult' - type: array - required: - - accountScore - Installments: - example: - value: 7 - properties: - value: - description: |- - Defines the number of installments. Its value needs to be greater than zero. - - Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. - format: int32 - type: integer - required: - - value - MerchantDevice: - example: - reference: reference - os: os - osVersion: osVersion - properties: - os: - description: Operating system running on the merchant device. - type: string - osVersion: - description: Version of the operating system on the merchant device. - type: string - reference: - description: Merchant device reference. - type: string - MerchantRiskIndicator: - example: - deliveryTimeframe: electronicDelivery - reorderItems: true - preOrderPurchase: true - preOrderDate: 2000-01-23T04:56:07.000+00:00 - giftCardAmount: - currency: currency - value: 0 - deliveryEmail: deliveryEmail - giftCardCount: 1 - addressMatch: true - deliveryAddressIndicator: shipToBillingAddress - properties: - addressMatch: - description: Whether the chosen delivery address is identical to the billing - address. - type: boolean - deliveryAddressIndicator: - description: |- - Indicator regarding the delivery address. - Allowed values: - * `shipToBillingAddress` - * `shipToVerifiedAddress` - * `shipToNewAddress` - * `shipToStore` - * `digitalGoods` - * `goodsNotShipped` - * `other` - enum: - - shipToBillingAddress - - shipToVerifiedAddress - - shipToNewAddress - - shipToStore - - digitalGoods - - goodsNotShipped - - other - type: string - deliveryEmail: - description: The delivery email address (for digital goods). - type: string - deliveryTimeframe: - description: |- - The estimated delivery time for the shopper to receive the goods. - Allowed values: - * `electronicDelivery` - * `sameDayShipping` - * `overnightShipping` - * `twoOrMoreDaysShipping` - enum: - - electronicDelivery - - sameDayShipping - - overnightShipping - - twoOrMoreDaysShipping - type: string - giftCardAmount: - $ref: '#/components/schemas/Amount' - giftCardCount: - description: Number of individual prepaid or gift cards used for this purchase. - format: int32 - type: integer - preOrderDate: - description: For pre-order purchases, the expected date this product will - be available to the shopper. - format: date-time - type: string - preOrderPurchase: - description: Indicator for whether this transaction is for pre-ordering - a product. - type: boolean - reorderItems: - description: Indicator for whether the shopper has already purchased the - same items in the past. - type: boolean - ModificationRequest: - example: - originalReference: originalReference - reference: reference - uniqueTerminalId: uniqueTerminalId + validTill: 2000-01-23T04:56:07.000+00:00 + signature: signature + accountType: accountType + buy: + currency: currency + value: 0 + sell: + currency: currency + value: 0 + interbank: + currency: currency + value: 0 + source: source + type: type + basePoints: 2 + account: account + baseAmount: + currency: currency + value: 0 + metadata: + key: metadata splits: - reference: reference amount: @@ -2624,12 +2520,185 @@ components: description: description type: BalanceAccount account: account - merchantAccount: merchantAccount - modificationAmount: + deviceFingerprint: deviceFingerprint + mcc: mcc + threeDSAuthenticationOnly: false + merchantRiskIndicator: + deliveryTimeframe: electronicDelivery + reorderItems: true + preOrderPurchase: true + preOrderDate: 2000-01-23T04:56:07.000+00:00 + giftCardAmount: + currency: currency + value: 0 + deliveryEmail: deliveryEmail + giftCardCount: 1 + addressMatch: true + deliveryAddressIndicator: shipToBillingAddress + reference: reference + deliveryAddress: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode + installments: + plan: regular + value: 7 + recurringProcessingModel: CardOnFile + additionalData: "" + selectedBrand: selectedBrand + trustedShopper: true + bankAccount: + ownerName: ownerName + countryCode: countryCode + taxId: taxId + iban: iban + bankAccountNumber: bankAccountNumber + bankName: bankName + bankLocationId: bankLocationId + bic: bic + bankCity: bankCity + fraudOffset: 4 + additionalAmount: currency: currency value: 0 - additionalData: "" - tenderReference: tenderReference + entityType: NaturalPerson + recurring: + recurringExpiry: 2000-01-23T04:56:07.000+00:00 + recurringFrequency: recurringFrequency + tokenService: VISATOKENSERVICE + contract: ONECLICK + recurringDetailName: recurringDetailName + shopperEmail: shopperEmail + nationality: nationality + threeDS2RequestData: + notificationURL: notificationURL + whiteListStatus: whiteListStatus + authenticationOnly: false + sdkMaxTimeout: 1 + sdkEncData: sdkEncData + acquirerBIN: acquirerBIN + mcc: mcc + threeDSRequestorID: threeDSRequestorID + deviceChannel: deviceChannel + deviceRenderOptions: + sdkUiType: + - multiSelect + - multiSelect + sdkInterface: both + sdkEphemPubKey: + kty: kty + crv: crv + x: x + y: "y" + merchantName: merchantName + transactionType: goodsOrServicePurchase + threeDSRequestorURL: threeDSRequestorURL + sdkReferenceNumber: sdkReferenceNumber + challengeIndicator: noPreference + threeDSRequestorName: threeDSRequestorName + acquirerMerchantID: acquirerMerchantID + sdkAppID: sdkAppID + messageVersion: 2.1.0 + threeDSCompInd: threeDSCompInd + sdkTransID: sdkTransID + orderReference: orderReference + shopperLocale: shopperLocale + captureDelayHours: 3 + fundingSource: debit + applicationInfo: + adyenLibrary: + name: name + version: version + merchantApplication: + name: name + version: version + adyenPaymentSource: + name: name + version: version + merchantDevice: + reference: reference + os: os + osVersion: osVersion + shopperInteractionDevice: + os: os + osVersion: osVersion + locale: locale + externalPlatform: + name: name + integrator: integrator + version: version + browserInfo: + acceptHeader: acceptHeader + screenWidth: 7 + javaEnabled: true + screenHeight: 2 + timeZoneOffset: 9 + javaScriptEnabled: true + language: language + userAgent: userAgent + colorDepth: 5 + card: + cvc: cvc + number: number + holderName: holderName + startMonth: startMonth + issueNumber: issueNumber + expiryMonth: expiryMonth + startYear: startYear + expiryYear: expiryYear + shopperReference: shopperReference + shopperStatement: shopperStatement + telephoneNumber: telephoneNumber + socialSecurityNumber: socialSecurityNumber + shopperIP: shopperIP + shopperName: + firstName: firstName + lastName: lastName + gender: MALE + infix: infix + enableRealTimeUpdate: true + selectedRecurringDetailReference: selectedRecurringDetailReference + shopperInteraction: Ecommerce + totalsGroup: totalsGroup + deliveryDate: 2000-01-23T04:56:07.000+00:00 + accountInfo: + passwordChangeDate: 2000-01-23T04:56:07.000+00:00 + paymentAccountIndicator: notApplicable + suspiciousActivity: true + deliveryAddressUsageIndicator: thisTransaction + pastTransactionsYear: 1 + accountType: notApplicable + homePhone: homePhone + paymentAccountAge: 2000-01-23T04:56:07.000+00:00 + accountAgeIndicator: notApplicable + deliveryAddressUsageDate: 2000-01-23T04:56:07.000+00:00 + accountChangeDate: 2000-01-23T04:56:07.000+00:00 + accountCreationDate: 2000-01-23T04:56:07.000+00:00 + mobilePhone: mobilePhone + pastTransactionsDay: 6 + accountChangeIndicator: thisTransaction + passwordChangeIndicator: notApplicable + addCardAttemptsDay: 0 + workPhone: workPhone + purchasesLast6Months: 5 + merchantOrderReference: merchantOrderReference + amount: + currency: currency + value: 0 + dateOfBirth: 2000-01-23T04:56:07.000+00:00 + sessionId: sessionId + store: store + merchantAccount: merchantAccount + billingAddress: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode mpiData: cavv: cavv authenticationResponse: "Y" @@ -2639,18 +2708,21 @@ components: directoryResponse: A eci: eci threeDSVersion: threeDSVersion - originalMerchantReference: originalMerchantReference properties: + accountInfo: + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + $ref: '#/components/schemas/Amount' additionalData: anyOf: - $ref: '#/components/schemas/AdditionalDataCommon' - - $ref: '#/components/schemas/AdditionalDataModifications' - $ref: '#/components/schemas/AdditionalData3DSecure' - $ref: '#/components/schemas/AdditionalDataAirline' - $ref: '#/components/schemas/AdditionalDataCarRental' - $ref: '#/components/schemas/AdditionalDataLevel23' - $ref: '#/components/schemas/AdditionalDataLodging' - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' - $ref: '#/components/schemas/AdditionalDataRatepay' - $ref: '#/components/schemas/AdditionalDataRetry' - $ref: '#/components/schemas/AdditionalDataRisk' @@ -2658,109 +2730,227 @@ components: - $ref: '#/components/schemas/AdditionalDataTemporaryServices' - $ref: '#/components/schemas/AdditionalDataWallets' description: |- - This field contains additional data, which may be required for a particular modification request. + This field contains additional data, which may be required for a particular payment request. - The additionalData object consists of entries, each of which includes the key and value. + The `additionalData` object consists of entries, each of which includes the key and value. + amount: + $ref: '#/components/schemas/Amount' + applicationInfo: + $ref: '#/components/schemas/ApplicationInfo' + bankAccount: + $ref: '#/components/schemas/BankAccount' + billingAddress: + $ref: '#/components/schemas/Address' + browserInfo: + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + card: + $ref: '#/components/schemas/Card' + dateOfBirth: + description: |- + The shopper's date of birth. + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + format: date-time + type: string + dccQuote: + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + $ref: '#/components/schemas/Address' + deliveryDate: + description: |- + The date and time the purchased goods should be delivered. + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + Example: 2017-07-17T13:42:40.428+01:00 + format: date-time + type: string + deviceFingerprint: + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + type: string + enableRealTimeUpdate: + deprecated: true + description: Choose if a specific transaction should use the Real-time Account + Updater, regardless of other settings. + type: boolean + entityType: + description: The type of the entity the payment is processed for. + enum: + - NaturalPerson + - CompanyName + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + installments: + $ref: '#/components/schemas/Installments' + mcc: + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string merchantAccount: - description: The merchant account that is used to process the payment. + description: The merchant account identifier, with which you want to process + the transaction. type: string - modificationAmount: - $ref: '#/components/schemas/Amount' + merchantOrderReference: + description: |- + This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. + The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. + > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + type: string + merchantRiskIndicator: + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + additionalProperties: + type: string + description: |- + Metadata consists of entries, each of which includes a key and a value. + Limitations: Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". + type: object mpiData: $ref: '#/components/schemas/ThreeDSecureData' - originalMerchantReference: - description: The original merchant reference to cancel. + nationality: + description: The two-character country code of the shopper's nationality. + maxLength: 2 type: string - originalReference: - description: |- - The original pspReference of the payment to modify. - This reference is returned in: - * authorisation response - * authorisation notification + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + recurring: + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + description: | + Defines a recurring payment type. + Allowed values: + * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. + * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. + * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile type: string reference: description: |- - Optionally, you can specify your reference for the payment modification. This reference is visible in Customer Area and in reports. + The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. + If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters. type: string - splits: - description: Information on how the payment should be split between accounts - when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). - items: - $ref: '#/components/schemas/Split' - type: array - tenderReference: - description: The transaction reference provided by the PED. For point-of-sale - integrations only. + selectedBrand: + description: |- + Some payment methods require defining a value for this field to specify how to process the transaction. + + For the Bancontact payment method, it can be set to: + * `maestro` (default), to be processed like a Maestro card, or + * `bcmc`, to be processed like a Bancontact card. type: string - uniqueTerminalId: - description: Unique terminal ID for the PED that originally processed the - request. For point-of-sale integrations only. + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. type: string - required: - - merchantAccount - - originalReference - ModificationResult: - example: - response: '[capture-received]' - additionalData: '{}' - pspReference: pspReference - properties: - additionalData: - description: This field contains additional data, which may be returned - in a particular modification response. - type: object - pspReference: - description: Adyen's 16-character string reference associated with the transaction/request. - This value is globally unique; quote it when communicating with us about - this request. + sessionId: + description: A session ID used to identify a payment session. type: string - response: - description: Indicates if the modification request has been received for - processing. - enum: - - '[capture-received]' - - '[cancel-received]' - - '[refund-received]' - - '[cancelOrRefund-received]' - - '[adjustAuthorisation-received]' - - '[technical-cancel-received]' - - '[voidPendingRefund-received]' + shopperEmail: + description: |- + The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. + > For 3D Secure 2 transactions, schemes require the `shopperEmail` for both `deviceChannel` **browser** and **app**. type: string - Name: - example: - firstName: firstName - lastName: lastName - gender: MALE - infix: infix - properties: - firstName: - description: The first name. + shopperIP: + description: |- + The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). + > Required for 3D Secure 2 transactions. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new). type: string - gender: + shopperInteraction: description: |- - The gender. - >The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`. + Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. + For the web service API, Adyen assumes Ecommerce shopper interaction by default. + + This field has the following possible values: + * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. + * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). + * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. + * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. enum: - - MALE - - FEMALE - - UNKNOWN - maxLength: 1 - minLength: 1 + - Ecommerce + - ContAuth + - Moto + - POS type: string - infix: + shopperLocale: + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + $ref: '#/components/schemas/Name' + shopperReference: description: |- - The name's infix, if applicable. - >A maximum length of twenty (20) characters is imposed. + Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. + > This field is required for recurring payments. type: string - lastName: - description: The last name. + shopperStatement: + description: |- + The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. + type: string + socialSecurityNumber: + description: The shopper's social security number. + type: string + splits: + description: Information on how the payment should be split between accounts + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + store: + description: The physical store, for which this payment is processed. + maxLength: 16 + minLength: 1 + type: string + telephoneNumber: + description: The shopper's telephone number. + type: string + threeDS2RequestData: + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 type: string + trustedShopper: + description: Set to true if the payment should be routed to a trusted MID. + type: boolean required: - - firstName - - gender - - lastName - PaymentRequest: + - amount + - merchantAccount + - reference + PaymentRequest3d: example: dccQuote: reference: reference @@ -2783,7 +2973,8 @@ components: baseAmount: currency: currency value: 0 - metadata: '{}' + metadata: + key: metadata splits: - reference: reference amount: @@ -2799,9 +2990,12 @@ components: description: description type: BalanceAccount account: account + telephoneNumber: telephoneNumber deviceFingerprint: deviceFingerprint + socialSecurityNumber: socialSecurityNumber + shopperIP: shopperIP mcc: mcc - threeDSAuthenticationOnly: true + threeDSAuthenticationOnly: false merchantRiskIndicator: deliveryTimeframe: electronicDelivery reorderItems: true @@ -2815,6 +3009,12 @@ components: addressMatch: true deliveryAddressIndicator: shipToBillingAddress reference: reference + shopperName: + firstName: firstName + lastName: lastName + gender: MALE + infix: infix + enableRealTimeUpdate: true deliveryAddress: country: country stateOrProvince: stateOrProvince @@ -2823,38 +3023,61 @@ components: street: street postalCode: postalCode installments: + plan: regular value: 7 + md: md recurringProcessingModel: CardOnFile + selectedRecurringDetailReference: selectedRecurringDetailReference + shopperInteraction: Ecommerce + totalsGroup: totalsGroup additionalData: "" selectedBrand: selectedBrand + deliveryDate: 2000-01-23T04:56:07.000+00:00 trustedShopper: true - bankAccount: - ownerName: ownerName - countryCode: countryCode - taxId: taxId - iban: iban - bankAccountNumber: bankAccountNumber - bankName: bankName - bankLocationId: bankLocationId - bic: bic - bankCity: bankCity - fraudOffset: 4 + accountInfo: + passwordChangeDate: 2000-01-23T04:56:07.000+00:00 + paymentAccountIndicator: notApplicable + suspiciousActivity: true + deliveryAddressUsageIndicator: thisTransaction + pastTransactionsYear: 1 + accountType: notApplicable + homePhone: homePhone + paymentAccountAge: 2000-01-23T04:56:07.000+00:00 + accountAgeIndicator: notApplicable + deliveryAddressUsageDate: 2000-01-23T04:56:07.000+00:00 + accountChangeDate: 2000-01-23T04:56:07.000+00:00 + accountCreationDate: 2000-01-23T04:56:07.000+00:00 + mobilePhone: mobilePhone + pastTransactionsDay: 6 + accountChangeIndicator: thisTransaction + passwordChangeIndicator: notApplicable + addCardAttemptsDay: 0 + workPhone: workPhone + purchasesLast6Months: 5 + fraudOffset: 6 + merchantOrderReference: merchantOrderReference + amount: + currency: currency + value: 0 additionalAmount: currency: currency value: 0 - entityType: NaturalPerson recurring: recurringExpiry: 2000-01-23T04:56:07.000+00:00 recurringFrequency: recurringFrequency tokenService: VISATOKENSERVICE contract: ONECLICK recurringDetailName: recurringDetailName + dateOfBirth: 2000-01-23T04:56:07.000+00:00 shopperEmail: shopperEmail - nationality: nationality + sessionId: sessionId + store: store + paResponse: paResponse + merchantAccount: merchantAccount threeDS2RequestData: notificationURL: notificationURL whiteListStatus: whiteListStatus - authenticationOnly: true + authenticationOnly: false sdkMaxTimeout: 1 sdkEncData: sdkEncData acquirerBIN: acquirerBIN @@ -2865,7 +3088,7 @@ components: sdkUiType: - multiSelect - multiSelect - sdkInterface: Html + sdkInterface: both sdkEphemPubKey: kty: kty crv: crv @@ -2879,13 +3102,19 @@ components: threeDSRequestorName: threeDSRequestorName acquirerMerchantID: acquirerMerchantID sdkAppID: sdkAppID - messageVersion: messageVersion + messageVersion: 2.1.0 threeDSCompInd: threeDSCompInd sdkTransID: sdkTransID orderReference: orderReference + billingAddress: + country: country + stateOrProvince: stateOrProvince + city: city + houseNumberOrName: houseNumberOrName + street: street + postalCode: postalCode shopperLocale: shopperLocale - captureDelayHours: 3 - fundingSource: debit + captureDelayHours: 0 applicationInfo: adyenLibrary: name: name @@ -2918,74 +3147,8 @@ components: language: language userAgent: userAgent colorDepth: 5 - card: - cvc: cvc - number: number - holderName: holderName - startMonth: startMonth - issueNumber: issueNumber - expiryMonth: expiryMonth - startYear: startYear - expiryYear: expiryYear shopperReference: shopperReference shopperStatement: shopperStatement - telephoneNumber: telephoneNumber - socialSecurityNumber: socialSecurityNumber - shopperIP: shopperIP - shopperName: - firstName: firstName - lastName: lastName - gender: MALE - infix: infix - enableRealTimeUpdate: true - selectedRecurringDetailReference: selectedRecurringDetailReference - shopperInteraction: Ecommerce - totalsGroup: totalsGroup - deliveryDate: 2000-01-23T04:56:07.000+00:00 - accountInfo: - passwordChangeDate: 2000-01-23T04:56:07.000+00:00 - paymentAccountIndicator: notApplicable - suspiciousActivity: true - deliveryAddressUsageIndicator: thisTransaction - pastTransactionsYear: 1 - accountType: notApplicable - homePhone: homePhone - paymentAccountAge: 2000-01-23T04:56:07.000+00:00 - accountAgeIndicator: notApplicable - deliveryAddressUsageDate: 2000-01-23T04:56:07.000+00:00 - accountChangeDate: 2000-01-23T04:56:07.000+00:00 - accountCreationDate: 2000-01-23T04:56:07.000+00:00 - mobilePhone: mobilePhone - pastTransactionsDay: 6 - accountChangeIndicator: thisTransaction - passwordChangeIndicator: notApplicable - addCardAttemptsDay: 0 - workPhone: workPhone - purchasesLast6Months: 5 - merchantOrderReference: merchantOrderReference - amount: - currency: currency - value: 0 - dateOfBirth: 2000-01-23T04:56:07.000+00:00 - sessionId: sessionId - store: store - merchantAccount: merchantAccount - billingAddress: - country: country - stateOrProvince: stateOrProvince - city: city - houseNumberOrName: houseNumberOrName - street: street - postalCode: postalCode - mpiData: - cavv: cavv - authenticationResponse: "Y" - xid: xid - cavvAlgorithm: cavvAlgorithm - dsTransID: dsTransID - directoryResponse: A - eci: eci - threeDSVersion: threeDSVersion properties: accountInfo: $ref: '#/components/schemas/AccountInfo' @@ -3000,6 +3163,7 @@ components: - $ref: '#/components/schemas/AdditionalDataLevel23' - $ref: '#/components/schemas/AdditionalDataLodging' - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' - $ref: '#/components/schemas/AdditionalDataRatepay' - $ref: '#/components/schemas/AdditionalDataRetry' - $ref: '#/components/schemas/AdditionalDataRisk' @@ -3014,8 +3178,6 @@ components: $ref: '#/components/schemas/Amount' applicationInfo: $ref: '#/components/schemas/ApplicationInfo' - bankAccount: - $ref: '#/components/schemas/BankAccount' billingAddress: $ref: '#/components/schemas/Address' browserInfo: @@ -3025,8 +3187,6 @@ components: specified in hours. format: int32 type: integer - card: - $ref: '#/components/schemas/Card' dateOfBirth: description: |- The shopper's date of birth. @@ -3056,27 +3216,11 @@ components: description: Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. type: boolean - entityType: - description: The type of the entity the payment is processed for. - enum: - - NaturalPerson - - CompanyName - type: string fraudOffset: description: An integer value that is added to the normal fraud score. The value can be either positive or negative. format: int32 type: integer - fundingSource: - description: |- - How to process combo card (for some Brazilian cards only). - Allowed values: - * debit - * credit - enum: - - debit - - credit - type: string installments: $ref: '#/components/schemas/Installments' mcc: @@ -3084,6 +3228,9 @@ components: (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. type: string + md: + description: The payment session identifier returned by the card issuer. + type: string merchantAccount: description: The merchant account identifier, with which you want to process the transaction. @@ -3097,22 +3244,22 @@ components: merchantRiskIndicator: $ref: '#/components/schemas/MerchantRiskIndicator' metadata: + additionalProperties: + type: string description: |- Metadata consists of entries, each of which includes a key and a value. Limitations: Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". type: object - mpiData: - $ref: '#/components/schemas/ThreeDSecureData' - nationality: - description: The two-character country code of the shopper's nationality. - maxLength: 2 - type: string orderReference: description: When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. type: string + paResponse: + description: Payment authorisation response returned by the card issuer. + The `paResponse` field holds the PaRes value received from the card issuer. + type: string recurring: $ref: '#/components/schemas/Recurring' recurringProcessingModel: @@ -3120,8 +3267,8 @@ components: Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. - * `CardOnFile` – Card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. - * `UnscheduledCardOnFile` – A transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. + * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. enum: - CardOnFile - Subscription @@ -3183,18 +3330,20 @@ components: $ref: '#/components/schemas/Name' shopperReference: description: |- - The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). + Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. type: string shopperStatement: - description: The text to appear on the shopper's bank statement. + description: |- + The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. type: string socialSecurityNumber: description: The shopper's social security number. type: string splits: description: Information on how the payment should be split between accounts - when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3209,6 +3358,7 @@ components: threeDS2RequestData: $ref: '#/components/schemas/ThreeDS2RequestData' threeDSAuthenticationOnly: + default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean @@ -3222,11 +3372,22 @@ components: description: Set to true if the payment should be routed to a trusted MID. type: boolean required: - - amount + - md - merchantAccount - - reference - PaymentRequest3d: + - paResponse + PaymentRequest3ds2: example: + threeDS2Result: + whiteListStatus: whiteListStatus + cavvAlgorithm: cavvAlgorithm + dsTransID: dsTransID + transStatusReason: transStatusReason + eci: eci + messageVersion: messageVersion + authenticationValue: authenticationValue + transStatus: transStatus + threeDSServerTransID: threeDSServerTransID + timestamp: timestamp dccQuote: reference: reference validTill: 2000-01-23T04:56:07.000+00:00 @@ -3248,7 +3409,8 @@ components: baseAmount: currency: currency value: 0 - metadata: '{}' + metadata: + key: metadata splits: - reference: reference amount: @@ -3269,7 +3431,7 @@ components: socialSecurityNumber: socialSecurityNumber shopperIP: shopperIP mcc: mcc - threeDSAuthenticationOnly: true + threeDSAuthenticationOnly: false merchantRiskIndicator: deliveryTimeframe: electronicDelivery reorderItems: true @@ -3297,8 +3459,8 @@ components: street: street postalCode: postalCode installments: + plan: regular value: 7 - md: md recurringProcessingModel: CardOnFile selectedRecurringDetailReference: selectedRecurringDetailReference shopperInteraction: Ecommerce @@ -3332,6 +3494,7 @@ components: amount: currency: currency value: 0 + threeDS2Token: threeDS2Token additionalAmount: currency: currency value: 0 @@ -3345,12 +3508,11 @@ components: shopperEmail: shopperEmail sessionId: sessionId store: store - paResponse: paResponse merchantAccount: merchantAccount threeDS2RequestData: notificationURL: notificationURL whiteListStatus: whiteListStatus - authenticationOnly: true + authenticationOnly: false sdkMaxTimeout: 1 sdkEncData: sdkEncData acquirerBIN: acquirerBIN @@ -3361,7 +3523,7 @@ components: sdkUiType: - multiSelect - multiSelect - sdkInterface: Html + sdkInterface: both sdkEphemPubKey: kty: kty crv: crv @@ -3375,7 +3537,7 @@ components: threeDSRequestorName: threeDSRequestorName acquirerMerchantID: acquirerMerchantID sdkAppID: sdkAppID - messageVersion: messageVersion + messageVersion: 2.1.0 threeDSCompInd: threeDSCompInd sdkTransID: sdkTransID orderReference: orderReference @@ -3436,6 +3598,7 @@ components: - $ref: '#/components/schemas/AdditionalDataLevel23' - $ref: '#/components/schemas/AdditionalDataLodging' - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' - $ref: '#/components/schemas/AdditionalDataRatepay' - $ref: '#/components/schemas/AdditionalDataRetry' - $ref: '#/components/schemas/AdditionalDataRisk' @@ -3500,9 +3663,6 @@ components: (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. type: string - md: - description: The payment session identifier returned by the card issuer. - type: string merchantAccount: description: The merchant account identifier, with which you want to process the transaction. @@ -3516,6 +3676,8 @@ components: merchantRiskIndicator: $ref: '#/components/schemas/MerchantRiskIndicator' metadata: + additionalProperties: + type: string description: |- Metadata consists of entries, each of which includes a key and a value. Limitations: Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". @@ -3526,10 +3688,6 @@ components: payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. type: string - paResponse: - description: Payment authorisation response returned by the card issuer. - The `paResponse` field holds the PaRes value received from the card issuer. - type: string recurring: $ref: '#/components/schemas/Recurring' recurringProcessingModel: @@ -3537,8 +3695,8 @@ components: Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. - * `CardOnFile` – Card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. - * `UnscheduledCardOnFile` – A transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. + * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. enum: - CardOnFile - Subscription @@ -3600,18 +3758,20 @@ components: $ref: '#/components/schemas/Name' shopperReference: description: |- - The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). + Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. type: string shopperStatement: - description: The text to appear on the shopper's bank statement. + description: |- + The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. type: string socialSecurityNumber: description: The shopper's social security number. type: string splits: description: Information on how the payment should be split between accounts - when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3619,599 +3779,712 @@ components: description: The physical store, for which this payment is processed. maxLength: 16 minLength: 1 - type: string - telephoneNumber: - description: The shopper's telephone number. - type: string - threeDS2RequestData: - $ref: '#/components/schemas/ThreeDS2RequestData' - threeDSAuthenticationOnly: - description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), - and not the payment authorisation. - type: boolean - totalsGroup: - description: The reference value to aggregate sales totals in reporting. - When not specified, the store field is used (if available). - maxLength: 16 - minLength: 1 - type: string - trustedShopper: - description: Set to true if the payment should be routed to a trusted MID. - type: boolean - required: - - md - - merchantAccount - - paResponse - PaymentRequest3ds2: - example: - threeDS2Result: - whiteListStatus: whiteListStatus - cavvAlgorithm: cavvAlgorithm - dsTransID: dsTransID - transStatusReason: transStatusReason - eci: eci - messageVersion: messageVersion - authenticationValue: authenticationValue - transStatus: transStatus - threeDSServerTransID: threeDSServerTransID - timestamp: timestamp - dccQuote: - reference: reference - validTill: 2000-01-23T04:56:07.000+00:00 - signature: signature - accountType: accountType - buy: - currency: currency - value: 0 - sell: - currency: currency - value: 0 - interbank: - currency: currency - value: 0 - source: source - type: type - basePoints: 2 - account: account - baseAmount: - currency: currency - value: 0 - metadata: '{}' - splits: - - reference: reference - amount: - currency: currency - value: 6 - description: description - type: BalanceAccount - account: account - - reference: reference - amount: - currency: currency - value: 6 - description: description - type: BalanceAccount - account: account - telephoneNumber: telephoneNumber - deviceFingerprint: deviceFingerprint - socialSecurityNumber: socialSecurityNumber - shopperIP: shopperIP - mcc: mcc - threeDSAuthenticationOnly: true - merchantRiskIndicator: - deliveryTimeframe: electronicDelivery - reorderItems: true - preOrderPurchase: true - preOrderDate: 2000-01-23T04:56:07.000+00:00 - giftCardAmount: - currency: currency - value: 0 - deliveryEmail: deliveryEmail - giftCardCount: 1 - addressMatch: true - deliveryAddressIndicator: shipToBillingAddress - reference: reference - shopperName: - firstName: firstName - lastName: lastName - gender: MALE - infix: infix - enableRealTimeUpdate: true - deliveryAddress: - country: country - stateOrProvince: stateOrProvince - city: city - houseNumberOrName: houseNumberOrName - street: street - postalCode: postalCode - installments: - value: 7 - recurringProcessingModel: CardOnFile - selectedRecurringDetailReference: selectedRecurringDetailReference - shopperInteraction: Ecommerce - totalsGroup: totalsGroup + type: string + telephoneNumber: + description: The shopper's telephone number. + type: string + threeDS2RequestData: + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDS2Result: + $ref: '#/components/schemas/ThreeDS2Result' + threeDS2Token: + description: The ThreeDS2Token that was returned in the /authorise call. + type: string + threeDSAuthenticationOnly: + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 + type: string + trustedShopper: + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - amount + - merchantAccount + - reference + PaymentResult: + example: + authCode: authCode + paRequest: paRequest + issuerUrl: issuerUrl + md: md + dccSignature: dccSignature + resultCode: AuthenticationFinished + refusalReason: refusalReason additionalData: "" - selectedBrand: selectedBrand - deliveryDate: 2000-01-23T04:56:07.000+00:00 - trustedShopper: true - accountInfo: - passwordChangeDate: 2000-01-23T04:56:07.000+00:00 - paymentAccountIndicator: notApplicable - suspiciousActivity: true - deliveryAddressUsageIndicator: thisTransaction - pastTransactionsYear: 1 - accountType: notApplicable - homePhone: homePhone - paymentAccountAge: 2000-01-23T04:56:07.000+00:00 - accountAgeIndicator: notApplicable - deliveryAddressUsageDate: 2000-01-23T04:56:07.000+00:00 - accountChangeDate: 2000-01-23T04:56:07.000+00:00 - accountCreationDate: 2000-01-23T04:56:07.000+00:00 - mobilePhone: mobilePhone - pastTransactionsDay: 6 - accountChangeIndicator: thisTransaction - passwordChangeIndicator: notApplicable - addCardAttemptsDay: 0 - workPhone: workPhone - purchasesLast6Months: 5 - fraudOffset: 6 - merchantOrderReference: merchantOrderReference - amount: - currency: currency - value: 0 - threeDS2Token: threeDS2Token - additionalAmount: + dccAmount: currency: currency value: 0 - recurring: - recurringExpiry: 2000-01-23T04:56:07.000+00:00 - recurringFrequency: recurringFrequency - tokenService: VISATOKENSERVICE - contract: ONECLICK - recurringDetailName: recurringDetailName - dateOfBirth: 2000-01-23T04:56:07.000+00:00 - shopperEmail: shopperEmail - sessionId: sessionId - store: store - merchantAccount: merchantAccount - threeDS2RequestData: - notificationURL: notificationURL - whiteListStatus: whiteListStatus - authenticationOnly: true - sdkMaxTimeout: 1 - sdkEncData: sdkEncData - acquirerBIN: acquirerBIN - mcc: mcc - threeDSRequestorID: threeDSRequestorID - deviceChannel: deviceChannel - deviceRenderOptions: - sdkUiType: - - multiSelect - - multiSelect - sdkInterface: Html - sdkEphemPubKey: - kty: kty - crv: crv - x: x - y: "y" - merchantName: merchantName - transactionType: goodsOrServicePurchase - threeDSRequestorURL: threeDSRequestorURL - sdkReferenceNumber: sdkReferenceNumber - challengeIndicator: noPreference - threeDSRequestorName: threeDSRequestorName - acquirerMerchantID: acquirerMerchantID - sdkAppID: sdkAppID - messageVersion: messageVersion - threeDSCompInd: threeDSCompInd - sdkTransID: sdkTransID - orderReference: orderReference - billingAddress: - country: country - stateOrProvince: stateOrProvince - city: city - houseNumberOrName: houseNumberOrName - street: street - postalCode: postalCode - shopperLocale: shopperLocale - captureDelayHours: 0 - applicationInfo: - adyenLibrary: - name: name - version: version - merchantApplication: - name: name - version: version - adyenPaymentSource: + fraudResult: + accountScore: 0 + results: + - accountScore: 6 name: name - version: version - merchantDevice: - reference: reference - os: os - osVersion: osVersion - shopperInteractionDevice: - os: os - osVersion: osVersion - locale: locale - externalPlatform: + checkId: 1 + - accountScore: 6 name: name - integrator: integrator - version: version - browserInfo: - acceptHeader: acceptHeader - screenWidth: 7 - javaEnabled: true - screenHeight: 2 - timeZoneOffset: 9 - javaScriptEnabled: true - language: language - userAgent: userAgent - colorDepth: 5 - shopperReference: shopperReference - shopperStatement: shopperStatement + checkId: 1 + pspReference: pspReference + properties: + additionalData: + anyOf: + - $ref: '#/components/schemas/ResponseAdditionalDataCommon' + - $ref: '#/components/schemas/ResponseAdditionalData3DSecure' + - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress' + - $ref: '#/components/schemas/ResponseAdditionalDataCard' + - $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress' + - $ref: '#/components/schemas/ResponseAdditionalDataInstallments' + - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens' + - $ref: '#/components/schemas/ResponseAdditionalDataOpi' + - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' + - $ref: '#/components/schemas/ResponseAdditionalDataSepa' + description: This field contains additional data, which may be required + to return in a particular payment response. To choose data fields to be + returned, go to **Customer Area** > **Account** > **API URLs** > **Additional + data settings**. + authCode: + description: |- + Authorisation code: + * When the payment is authorised successfully, this field holds the authorisation code for the payment. + * When the payment is not authorised, this field is empty. + type: string + dccAmount: + $ref: '#/components/schemas/Amount' + dccSignature: + description: |- + Cryptographic signature used to verify `dccQuote`. + > This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new). + type: string + fraudResult: + $ref: '#/components/schemas/FraudResult' + issuerUrl: + description: |- + The URL to direct the shopper to. + > In case of SecurePlus, do not redirect a shopper to this URL. + type: string + md: + description: The payment session. + type: string + paRequest: + description: |- + The 3D request data for the issuer. + + If the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure). + type: string + pspReference: + description: |- + Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + + > `pspReference` is returned only for non-redirect payment methods. + type: string + refusalReason: + description: |- + If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + + For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + type: string + resultCode: + description: |- + The result of the payment. For more information, see [Result codes](https://docs.adyen.com/checkout/payment-result-codes). + + Possible values: + + * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. + * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). + * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. + * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. + * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. + * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. + * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. + * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. + * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. + * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. + * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. + * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused + type: string + Recurring: + example: + recurringExpiry: 2000-01-23T04:56:07.000+00:00 + recurringFrequency: recurringFrequency + tokenService: VISATOKENSERVICE + contract: ONECLICK + recurringDetailName: recurringDetailName + properties: + contract: + description: |- + The type of recurring contract to be used. + Possible values: + * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). + * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). + * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. + * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/checkout/online-payouts). + enum: + - ONECLICK + - RECURRING + - PAYOUT + type: string + recurringDetailName: + description: A descriptive name for this detail. + type: string + recurringExpiry: + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + format: date-time + type: string + recurringFrequency: + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + tokenService: + description: The name of the token service. + enum: + - VISATOKENSERVICE + - MCTOKENSERVICE + type: string + ResponseAdditionalData3DSecure: properties: - accountInfo: - $ref: '#/components/schemas/AccountInfo' - additionalAmount: - $ref: '#/components/schemas/Amount' - additionalData: - anyOf: - - $ref: '#/components/schemas/AdditionalDataCommon' - - $ref: '#/components/schemas/AdditionalData3DSecure' - - $ref: '#/components/schemas/AdditionalDataAirline' - - $ref: '#/components/schemas/AdditionalDataCarRental' - - $ref: '#/components/schemas/AdditionalDataLevel23' - - $ref: '#/components/schemas/AdditionalDataLodging' - - $ref: '#/components/schemas/AdditionalDataOpenInvoice' - - $ref: '#/components/schemas/AdditionalDataRatepay' - - $ref: '#/components/schemas/AdditionalDataRetry' - - $ref: '#/components/schemas/AdditionalDataRisk' - - $ref: '#/components/schemas/AdditionalDataRiskStandalone' - - $ref: '#/components/schemas/AdditionalDataTemporaryServices' - - $ref: '#/components/schemas/AdditionalDataWallets' + scaExemptionRequested: + description: "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ + \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\ + \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " + type: string + ResponseAdditionalDataBillingAddress: + properties: + billingAddress.city: + description: The billing address city passed in the payment request. + type: string + billingAddress.country: + description: |- + The billing address country passed in the payment request. + + Example: NL + type: string + billingAddress.houseNumberOrName: + description: The billing address house number or name passed in the payment + request. + type: string + billingAddress.postalCode: + description: |- + The billing address postal code passed in the payment request. + + Example: 1011 DJ + type: string + billingAddress.stateOrProvince: + description: |- + The billing address state or province passed in the payment request. + + Example: NH + type: string + billingAddress.street: + description: The billing address street passed in the payment request. + type: string + ResponseAdditionalDataCard: + properties: + cardBin: + description: |- + The Bank Identification Number of a credit card, which is the first six digits of a card number. + + Example: 521234 + type: string + cardHolderName: + description: The cardholder name passed in the payment request. + type: string + cardIssuingBank: + description: The bank or the financial institution granting lines of credit + through card association branded payment cards. This information can be + included when available. + type: string + cardIssuingCountry: + description: |- + The country where the card was issued. + + Example: US + type: string + cardIssuingCurrency: + description: "The currency in which the card is issued, if this information\ + \ is available. Provided as the currency code or currency number from\ + \ the ISO-4217 standard. \n\nExample: USD" + type: string + cardPaymentMethod: + description: |- + The card payment method used for the transaction. + + Example: amex + type: string + cardSummary: + description: |- + The last four digits of a card number. + + > Returned only in case of a card payment. + type: string + ResponseAdditionalDataCommon: + properties: + acquirerAccountCode: + description: |- + The name of the Adyen acquirer account. + + Example: PayPalSandbox_TestAcquirer + + > Only relevant for PayPal transactions. + type: string + acquirerCode: + description: |- + The name of the acquirer processing the payment request. + + Example: TestPmmAcquirer + type: string + acquirerReference: + description: |- + The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. + + Example: 7C9N3FNBKT9 + type: string + alias: + description: |- + The Adyen alias of the card. + + Example: H167852639363479 + type: string + aliasType: + description: |- + The type of the card alias. + + Example: Default + type: string + authCode: + description: |- + Authorisation code: + * When the payment is authorised successfully, this field holds the authorisation code for the payment. + * When the payment is not authorised, this field is empty. + + Example: 58747 + type: string + authorisedAmountCurrency: + description: The currency of the authorised amount, as a three-character + [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + type: string + authorisedAmountValue: + description: |- + Value of the amount authorised. + + This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + type: string + avsResult: + description: |- + The AVS result code of the payment, which provides information about the outcome of the AVS check. + + For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs). + type: string + avsResultRaw: + description: |- + Raw AVS result received from the acquirer, where available. + + Example: D + type: string + bic: + description: |- + BIC of a bank account. + + Example: TESTNL01 + + > Only relevant for SEPA Direct Debit transactions. + type: string + dsTransID: + description: Supported for 3D Secure 2. The unique transaction identifier + assigned by the DS to identify a single transaction. + type: string + eci: + description: |- + The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. + + Example: 02 + type: string + expiryDate: + description: |- + The expiry date on the card. + + Example: 6/2016 + + > Returned only in case of a card payment. + type: string + extraCostsCurrency: + description: |- + The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. + + Example: EUR + type: string + extraCostsValue: + description: The value of the extra amount charged due to additional amounts + set in the skin used in the HPP payment request. The amount is in minor + units. + type: string + fraudCheck-[itemNr]-[FraudCheckname]: + description: The fraud score due to a particular fraud check. The fraud + check name is found in the key of the key-value pair. + type: string + fundingSource: + description: |- + Information regarding the funding type of the card. The possible return values are: + * CHARGE + * CREDIT + * DEBIT + * PREPAID + * PREPAID_RELOADABLE + + * PREPAID_NONRELOADABLE + * DEFFERED_DEBIT + + > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. + + For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. + type: string + fundsAvailability: + description: |- + Indicates availability of funds. + + Visa: + * "I" (fast funds are supported) + * "N" (otherwise) + + Mastercard: + * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) + * "N" (otherwise) + + > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is "Y" or "D". + type: string + inferredRefusalReason: + description: |- + Provides the more granular indication of why a transaction was refused. When a transaction fails with either "Refused", "Restricted Card", "Transaction Not Permitted", "Not supported" or "DeclinedNon Generic" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to "Not Supported". + + Possible values: + + * 3D Secure Mandated + * Closed Account + * ContAuth Not Supported + * CVC Mandated + * Ecommerce Not Allowed + * Crossborder Not Supported + * Card Updated + + * Low Authrate Bin + * Non-reloadable prepaid card + type: string + issuerCountry: description: |- - This field contains additional data, which may be required for a particular payment request. + The issuing country of the card based on the BIN list that Adyen maintains. - The `additionalData` object consists of entries, each of which includes the key and value. - amount: - $ref: '#/components/schemas/Amount' - applicationInfo: - $ref: '#/components/schemas/ApplicationInfo' - billingAddress: - $ref: '#/components/schemas/Address' - browserInfo: - $ref: '#/components/schemas/BrowserInfo' - captureDelayHours: - description: The delay between the authorisation and scheduled auto-capture, - specified in hours. - format: int32 - type: integer - dateOfBirth: + Example: JP + type: string + mcBankNetReferenceNumber: description: |- - The shopper's date of birth. + The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. - Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD - format: date-time + > Contact Support Team to enable this field. type: string - dccQuote: - $ref: '#/components/schemas/ForexQuote' - deliveryAddress: - $ref: '#/components/schemas/Address' - deliveryDate: + networkTxReference: description: |- - The date and time the purchased goods should be delivered. + Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. - Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + This contains either the Mastercard Trace ID or the Visa Transaction ID. + type: string + ownerName: + description: |- + The owner name of a bank account. - Example: 2017-07-17T13:42:40.428+01:00 - format: date-time + Only relevant for SEPA Direct Debit transactions. type: string - deviceFingerprint: - description: A string containing the shopper's device fingerprint. For more - information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + paymentAccountReference: + description: The Payment Account Reference (PAR) value links a network token + with the underlying primary account number (PAN). The PAR value consists + of 29 uppercase alphanumeric characters. type: string - enableRealTimeUpdate: - deprecated: true - description: Choose if a specific transaction should use the Real-time Account - Updater, regardless of other settings. - type: boolean - fraudOffset: - description: An integer value that is added to the normal fraud score. The - value can be either positive or negative. - format: int32 - type: integer - installments: - $ref: '#/components/schemas/Installments' - mcc: - description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) - (MCC) is a four-digit number, which relates to a particular market segment. - This code reflects the predominant activity that is conducted by the merchant. + paymentMethodVariant: + description: |- + The Adyen sub-variant of the payment method used for the payment request. + + For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). + + Example: mcpro type: string - merchantAccount: - description: The merchant account identifier, with which you want to process - the transaction. + payoutEligible: + description: |- + Indicates whether a payout is eligible or not for this card. + + Visa: + * "Y" + * "N" + + Mastercard: + * "Y" (domestic and cross-border) + + * "D" (only domestic) + * "N" (no MoneySend) + * "U" (unknown) type: string - merchantOrderReference: + realtimeAccountUpdaterStatus: description: |- - This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. - The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. - > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + The response code from the Real Time Account Updater service. + + Possible return values are: + * CardChanged + * CardExpiryChanged + * CloseAccount + + * ContactCardAccountHolder type: string - merchantRiskIndicator: - $ref: '#/components/schemas/MerchantRiskIndicator' - metadata: + receiptFreeText: + description: Message to be displayed on the terminal. + type: string + recurring.firstPspReference: description: |- - Metadata consists of entries, each of which includes a key and a value. - Limitations: Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". - type: object - orderReference: - description: When you are doing multiple partial (gift card) payments, this - is the `pspReference` of the first payment. We use this to link the multiple - payments to each other. As your own reference for linking multiple payments, - use the `merchantOrderReference`instead. + The `pspReference`, of the first recurring payment that created the recurring detail. + + This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. type: string - recurring: - $ref: '#/components/schemas/Recurring' - recurringProcessingModel: - description: | - Defines a recurring payment type. - Allowed values: - * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. - * `CardOnFile` – Card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. - * `UnscheduledCardOnFile` – A transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. - enum: - - CardOnFile - - Subscription - - UnscheduledCardOnFile + recurring.recurringDetailReference: + description: The reference that uniquely identifies the recurring transaction. type: string - reference: + referred: description: |- - The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. - If you need to provide multiple references for a transaction, separate them with hyphens ("-"). - Maximum length: 80 characters. + If the payment is referred, this field is set to true. + + This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. + + Example: true type: string - selectedBrand: + refusalReasonRaw: description: |- - Some payment methods require defining a value for this field to specify how to process the transaction. + Raw refusal reason received from the acquirer, where available. - For the Bancontact payment method, it can be set to: - * `maestro` (default), to be processed like a Maestro card, or - * `bcmc`, to be processed like a Bancontact card. + Example: AUTHORISED type: string - selectedRecurringDetailReference: - description: The `recurringDetailReference` you want to use for this payment. - The value `LATEST` can be used to select the most recently stored recurring - detail. + shopperInteraction: + description: |- + The shopper interaction type of the payment request. + + Example: Ecommerce type: string - sessionId: - description: A session ID used to identify a payment session. + shopperReference: + description: |- + The shopperReference passed in the payment request. + + Example: AdyenTestShopperXX type: string - shopperEmail: + terminalId: description: |- - The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. - > For 3D Secure 2 transactions, schemes require the `shopperEmail` for both `deviceChannel` **browser** and **app**. + The terminal ID used in a point-of-sale payment. + + Example: 06022622 type: string - shopperIP: + threeDAuthenticated: description: |- - The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). - > Required for 3D Secure 2 transactions. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new). + A Boolean value indicating whether 3DS authentication was completed on this payment. + + Example: true type: string - shopperInteraction: + threeDAuthenticatedResponse: description: |- - Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. - For the web service API, Adyen assumes Ecommerce shopper interaction by default. + The raw 3DS authentication result from the card issuer. - This field has the following possible values: - * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. - * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). - * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. - * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. - enum: - - Ecommerce - - ContAuth - - Moto - - POS + Example: N type: string - shopperLocale: - description: The combination of a language code and a country code to specify - the language to be used in the payment. + threeDOffered: + description: |- + A Boolean value indicating whether 3DS was offered for this payment. + + Example: true + type: string + threeDOfferedResponse: + description: |- + The raw enrollment result from the 3DS directory services of the card schemes. + + Example: Y + type: string + threeDSVersion: + description: The 3D Secure 2 version. + type: string + visaTransactionId: + description: |- + The `visaTransactionId`, has a fixed length of 15 numeric characters. + + > Contact Support Team to enable this field. + type: string + xid: + description: |- + The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. + + Example: ODgxNDc2MDg2MDExODk5MAAAAAA= + type: string + ResponseAdditionalDataDeliveryAddress: + properties: + deliveryAddress.city: + description: The delivery address city passed in the payment request. + type: string + deliveryAddress.country: + description: |- + The delivery address country passed in the payment request. + + Example: NL + type: string + deliveryAddress.houseNumberOrName: + description: The delivery address house number or name passed in the payment + request. + type: string + deliveryAddress.postalCode: + description: |- + The delivery address postal code passed in the payment request. + + Example: 1011 DJ type: string - shopperName: - $ref: '#/components/schemas/Name' - shopperReference: + deliveryAddress.stateOrProvince: description: |- - The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). - > This field is required for recurring payments. + The delivery address state or province passed in the payment request. + + Example: NH type: string - shopperStatement: - description: The text to appear on the shopper's bank statement. + deliveryAddress.street: + description: The delivery address street passed in the payment request. type: string - socialSecurityNumber: - description: The shopper's social security number. + ResponseAdditionalDataInstallments: + properties: + installmentPaymentData.installmentType: + description: Type of installment. The value of `installmentType` should + be **IssuerFinanced**. type: string - splits: - description: Information on how the payment should be split between accounts - when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). - items: - $ref: '#/components/schemas/Split' - type: array - store: - description: The physical store, for which this payment is processed. - maxLength: 16 - minLength: 1 + installmentPaymentData.option[itemNr].annualPercentageRate: + description: Annual interest rate. type: string - telephoneNumber: - description: The shopper's telephone number. + installmentPaymentData.option[itemNr].firstInstallmentAmount: + description: First Installment Amount in minor units. type: string - threeDS2RequestData: - $ref: '#/components/schemas/ThreeDS2RequestData' - threeDS2Result: - $ref: '#/components/schemas/ThreeDS2Result' - threeDS2Token: - description: The ThreeDS2Token that was returned in the /authorise call. + installmentPaymentData.option[itemNr].installmentFee: + description: Installment fee amount in minor units. type: string - threeDSAuthenticationOnly: - description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), - and not the payment authorisation. - type: boolean - totalsGroup: - description: The reference value to aggregate sales totals in reporting. - When not specified, the store field is used (if available). - maxLength: 16 - minLength: 1 + installmentPaymentData.option[itemNr].interestRate: + description: Interest rate for the installment period. type: string - trustedShopper: - description: Set to true if the payment should be routed to a trusted MID. - type: boolean - required: - - amount - - merchantAccount - - reference - PaymentResult: - example: - authCode: authCode - paRequest: paRequest - issuerUrl: issuerUrl - md: md - dccSignature: dccSignature - resultCode: AuthenticationFinished - refusalReason: refusalReason - additionalData: "" - dccAmount: - currency: currency - value: 0 - fraudResult: - accountScore: 0 - results: - - accountScore: 6 - name: name - checkId: 1 - - accountScore: 6 - name: name - checkId: 1 - pspReference: pspReference - properties: - additionalData: - anyOf: - - $ref: '#/components/schemas/ResponseAdditionalDataCommon' - - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress' - - $ref: '#/components/schemas/ResponseAdditionalDataCard' - - $ref: '#/components/schemas/ResponseAdditionalDataDeliveryAddress' - - $ref: '#/components/schemas/ResponseAdditionalDataInstallments' - - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens' - - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - - $ref: '#/components/schemas/ResponseAdditionalDataSepa' - description: This field contains additional data, which may be required - to return in a particular payment response. To choose data fields to be - returned, go to **Customer Area** > **Account** > **API URLs** > **Additional - data settings**. - authCode: - description: |- - Authorisation code: - * When the payment is authorised successfully, this field holds the authorisation code for the payment. - * When the payment is not authorised, this field is empty. + installmentPaymentData.option[itemNr].maximumNumberOfInstallments: + description: Maximum number of installments possible for this payment. type: string - dccAmount: - $ref: '#/components/schemas/Amount' - dccSignature: + installmentPaymentData.option[itemNr].minimumNumberOfInstallments: + description: Minimum number of installments possible for this payment. + type: string + installmentPaymentData.option[itemNr].numberOfInstallments: + description: Total number of installments possible for this payment. + type: string + installmentPaymentData.option[itemNr].subsequentInstallmentAmount: + description: Subsequent Installment Amount in minor units. + type: string + installmentPaymentData.option[itemNr].totalAmountDue: + description: Total amount in minor units. + type: string + installmentPaymentData.paymentOptions: description: |- - Cryptographic signature used to verify `dccQuote`. - > This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new). + Possible values: + * PayInInstallmentsOnly + * PayInFullOnly + * PayInFullOrInstallments type: string - fraudResult: - $ref: '#/components/schemas/FraudResult' - issuerUrl: + installments.value: description: |- - The URL to direct the shopper to. - > In case of SecurePlus, do not redirect a shopper to this URL. + The number of installments that the payment amount should be charged with. + + Example: 5 + > Only relevant for card payments in countries that support installments. type: string - md: - description: The payment session. + ResponseAdditionalDataNetworkTokens: + properties: + networkToken.available: + description: Indicates whether a network token is available for the specified + card. type: string - paRequest: + networkToken.bin: + description: The Bank Identification Number of a tokenized card, which is + the first six digits of a card number. + type: string + networkToken.tokenSummary: + description: The last four digits of a network token. + type: string + ResponseAdditionalDataOpi: + properties: + opi.transToken: + description: 'Returned in the response if you included `opi.includeTransToken: + true` in an ecommerce payment request. This contains an Oracle Payment + Interface token that you can store in your Oracle Opera database to identify + tokenized ecommerce transactions. For more information and required settings, + see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' + type: string + ResponseAdditionalDataPayPal: + properties: + paypalEmail: description: |- - The 3D request data for the issuer. + The buyer's PayPal account email address. - If the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure). + Example: paypaltest@adyen.com type: string - pspReference: + paypalPayerId: description: |- - Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + The buyer's PayPal ID. - > `pspReference` is returned only for non-redirect payment methods. + Example: LF5HCWWBRV2KL type: string - refusalReason: + paypalPayerResidenceCountry: description: |- - If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. + The buyer's country of residence. - When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + Example: NL type: string - resultCode: + paypalPayerStatus: description: |- - The result of the payment. Possible values: + The status of the buyer's PayPal account. - * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. - * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. - * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. - * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. - * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. - * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. - * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. For more information, refer to [Result codes](https://docs.adyen.com/checkout/payment-result-codes). - * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. - * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. - * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. - * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. - enum: - - AuthenticationFinished - - Authorised - - Cancelled - - ChallengeShopper - - Error - - IdentifyShopper - - Pending - - PresentToShopper - - Received - - RedirectShopper - - Refused + Example: unverified type: string - Recurring: - example: - recurringExpiry: 2000-01-23T04:56:07.000+00:00 - recurringFrequency: recurringFrequency - tokenService: VISATOKENSERVICE - contract: ONECLICK - recurringDetailName: recurringDetailName - properties: - contract: + paypalProtectionEligibility: description: |- - The type of recurring contract to be used. - Possible values: - * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). - * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). - * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. - * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/checkout/online-payouts). - enum: - - ONECLICK - - RECURRING - - PAYOUT - type: string - recurringDetailName: - description: A descriptive name for this detail. + The eligibility for PayPal Seller Protection for this payment. + + Example: Ineligible type: string - recurringExpiry: - description: Date after which no further authorisations shall be performed. - Only for 3D Secure 2. - format: date-time + ResponseAdditionalDataSepa: + properties: + sepadirectdebit.dateOfSignature: + description: |- + The transaction signature date. + + Format: yyyy-MM-dd type: string - recurringFrequency: - description: Minimum number of days between authorisations. Only for 3D - Secure 2. + sepadirectdebit.mandateId: + description: Its value corresponds to the pspReference value of the transaction. type: string - tokenService: - description: The name of the token service. - enum: - - VISATOKENSERVICE - - MCTOKENSERVICE + sepadirectdebit.sequenceType: + description: |- + This field can take one of the following values: + * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. + + * First: (FRST) Initial/first collection in a series of direct debit instructions. + * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. + * Final: (FNAL) Last/final collection in a series of direct debit instructions. + + Example: OOFF type: string SDKEphemPubKey: example: @@ -4346,7 +4619,7 @@ components: example: notificationURL: notificationURL whiteListStatus: whiteListStatus - authenticationOnly: true + authenticationOnly: false sdkMaxTimeout: 1 sdkEncData: sdkEncData acquirerBIN: acquirerBIN @@ -4357,7 +4630,7 @@ components: sdkUiType: - multiSelect - multiSelect - sdkInterface: Html + sdkInterface: both sdkEphemPubKey: kty: kty crv: crv @@ -4371,7 +4644,7 @@ components: threeDSRequestorName: threeDSRequestorName acquirerMerchantID: acquirerMerchantID sdkAppID: sdkAppID - messageVersion: messageVersion + messageVersion: 2.1.0 threeDSCompInd: threeDSCompInd sdkTransID: sdkTransID properties: @@ -4387,9 +4660,13 @@ components: Use 123456 on the Test platform. type: string authenticationOnly: + default: false + deprecated: true description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean + x-deprecatedInVersion: 50 + x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. challengeIndicator: description: | Possibility to specify a preference for receiving a challenge from the issuer. @@ -4425,6 +4702,7 @@ components: > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/checkout/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account. type: string messageVersion: + default: 2.1.0 description: The `messageVersion` value indicating the 3D Secure 2 protocol version. type: string @@ -4605,8 +4883,6 @@ components: description: |- In 3D Secure 1, this is the enrollment response from the 3D directory server. - - In 3D Secure 2, this is the `transStatus` from the `ARes`. enum: - A @@ -4633,6 +4909,14 @@ components: 20 bytes in a decoded form). format: byte type: string + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http x-groups: - General - Modifications diff --git a/src/payments/api_default.go b/src/payments/api_default.go index 3a7bc461f..0ccd85908 100644 --- a/src/payments/api_default.go +++ b/src/payments/api_default.go @@ -1,9 +1,9 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,7 +14,7 @@ import ( _context "context" _nethttp "net/http" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // Payments Payments service @@ -25,184 +25,183 @@ var adyenLib = &CommonField{ Version: common.LibVersion, } -func setModificationRequestApplicationInfo(req *ModificationRequest) { - if req.ApplicationInfo == nil { - req.ApplicationInfo = &ApplicationInfo{} - } - req.ApplicationInfo.AdyenLibrary = adyenLib -} - /* -AdjustAuthorisation Increases or decreases the authorised amount. +PostAdjustAuthorisation Increases or decreases the authorised amount. Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables tipping, improving the chances your authorisation will be valid, charging the shopper when they have already left the merchant premises, etc. For more information, refer to [Adjust Authorisation](https://docs.adyen.com/checkout/adjust-authorisation). - * @param request ModificationRequest - reference of ModificationRequest). + * @param request ModificationRequest - reference of ModificationRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ModificationResult */ func (a Payments) AdjustAuthorisation(req *ModificationRequest, ctxs ..._context.Context) (ModificationResult, *_nethttp.Response, error) { - res := &ModificationResult{} - setModificationRequestApplicationInfo(req) + res := &ModificationResult{} httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/adjustAuthorisation", ctxs...) - return *res, httpRes, err + return *res, httpRes, err } /* -Authorise3d Completes a 3D Secure payment authorisation. -For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure. For more information, refer to [3D Secure](https://docs.adyen.com/classic-integration/3d-secure). - * @param request PaymentRequest3d - reference of PaymentRequest3d). +PostAuthorise Creates a payment authorisation. +Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation. For more information, refer to [Classic integration](https://docs.adyen.com/classic-integration). + * @param request PaymentRequest - reference of PaymentRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return PaymentResult */ -func (a Payments) Authorise3d(req *PaymentRequest3d, ctxs ..._context.Context) (PaymentResult, *_nethttp.Response, error) { - res := &PaymentResult{} +func (a Payments) Authorise(req *PaymentRequest, ctxs ..._context.Context) (PaymentResult, *_nethttp.Response, error) { + res := &PaymentResult{} if req.ApplicationInfo == nil { req.ApplicationInfo = &ApplicationInfo{} } req.ApplicationInfo.AdyenLibrary = adyenLib - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/authorise3d", ctxs...) - return *res, httpRes, err + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/authorise", ctxs...) + return *res, httpRes, err } /* -Authorise3ds2 Completes a 3D Secure 2 payment authorisation. -For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters. For more information, refer to [3D Secure 2](https://docs.adyen.com/checkout/3d-secure/native-3ds2). - * @param request PaymentRequest3ds2 - reference of PaymentRequest3ds2). +PostAuthorise3d Completes a 3D Secure payment authorisation. +For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure. For more information, refer to [3D Secure](https://docs.adyen.com/classic-integration/3d-secure). + * @param request PaymentRequest3d - reference of PaymentRequest3d). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return PaymentResult */ -func (a Payments) Authorise3ds2(req *PaymentRequest3ds2, ctxs ..._context.Context) (PaymentResult, *_nethttp.Response, error) { - res := &PaymentResult{} +func (a Payments) Authorise3d(req *PaymentRequest3d, ctxs ..._context.Context) (PaymentResult, *_nethttp.Response, error) { + res := &PaymentResult{} if req.ApplicationInfo == nil { req.ApplicationInfo = &ApplicationInfo{} } req.ApplicationInfo.AdyenLibrary = adyenLib - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/authorise3ds2", ctxs...) - return *res, httpRes, err + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/authorise3d", ctxs...) + return *res, httpRes, err } /* -Authorise Creates a payment authorisation. -Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation. For more information, refer to [Classic integration](https://docs.adyen.com/classic-integration). - * @param request PaymentRequest - reference of PaymentRequest). +PostAuthorise3ds2 Completes a 3D Secure 2 payment authorisation. +For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters. For more information, refer to [3D Secure 2](https://docs.adyen.com/checkout/3d-secure/native-3ds2). + * @param request PaymentRequest3ds2 - reference of PaymentRequest3ds2). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return PaymentResult */ -func (a Payments) Authorise(req *PaymentRequest, ctxs ..._context.Context) (PaymentResult, *_nethttp.Response, error) { - res := &PaymentResult{} +func (a Payments) Authorise3ds2(req *PaymentRequest3ds2, ctxs ..._context.Context) (PaymentResult, *_nethttp.Response, error) { + res := &PaymentResult{} if req.ApplicationInfo == nil { req.ApplicationInfo = &ApplicationInfo{} } req.ApplicationInfo.AdyenLibrary = adyenLib - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/authorise", ctxs...) - return *res, httpRes, err + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/authorise3ds2", ctxs...) + return *res, httpRes, err } /* -CancelOrRefund Cancels or refunds a payment. -Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture). > Do not use this request for payments that involve (multiple) partial captures. For more information, refer to [Cancel or refund](https://docs.adyen.com/checkout/cancel-or-refund). - * @param request ModificationRequest - reference of ModificationRequest). +PostCancel Cancels an authorised payment. +Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures. For more information, refer to [Cancel](https://docs.adyen.com/checkout/cancel). + * @param request ModificationRequest - reference of ModificationRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ModificationResult */ -func (a Payments) CancelOrRefund(req *ModificationRequest, ctxs ..._context.Context) (ModificationResult, *_nethttp.Response, error) { - res := &ModificationResult{} - setModificationRequestApplicationInfo(req) - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/cancelOrRefund", ctxs...) - return *res, httpRes, err +func (a Payments) Cancel(req *ModificationRequest, ctxs ..._context.Context) (ModificationResult, *_nethttp.Response, error) { + res := &ModificationResult{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/cancel", ctxs...) + return *res, httpRes, err } /* -Cancel Cancels an authorised payment. -Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures. For more information, refer to [Cancel](https://docs.adyen.com/checkout/cancel). - * @param request ModificationRequest - reference of ModificationRequest). +PostCancelOrRefund Cancels or refunds a payment. +Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture). > Do not use this request for payments that involve (multiple) partial captures. For more information, refer to [Cancel or refund](https://docs.adyen.com/checkout/cancel-or-refund). + * @param request ModificationRequest - reference of ModificationRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ModificationResult */ -func (a Payments) Cancel(req *ModificationRequest, ctxs ..._context.Context) (ModificationResult, *_nethttp.Response, error) { - res := &ModificationResult{} - setModificationRequestApplicationInfo(req) - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/cancel", ctxs...) - return *res, httpRes, err +func (a Payments) CancelOrRefund(req *ModificationRequest, ctxs ..._context.Context) (ModificationResult, *_nethttp.Response, error) { + res := &ModificationResult{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/cancelOrRefund", ctxs...) + return *res, httpRes, err } /* -Capture Captures an authorised payment. +PostCapture Captures an authorised payment. Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance. Payment methods, which automatically capture as part of authorisation, don't need to be captured, but submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary. For more information, refer to [Capture](https://docs.adyen.com/checkout/capture). - * @param request ModificationRequest - reference of ModificationRequest). + * @param request ModificationRequest - reference of ModificationRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ModificationResult */ func (a Payments) Capture(req *ModificationRequest, ctxs ..._context.Context) (ModificationResult, *_nethttp.Response, error) { - res := &ModificationResult{} - setModificationRequestApplicationInfo(req) - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/capture", ctxs...) - return *res, httpRes, err + res := &ModificationResult{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/capture", ctxs...) + return *res, httpRes, err +} + +/* +PostDonate Creates a payment for the specified donation. +Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment. For more information, see [Donate](https://docs.adyen.com/checkout/donate). + * @param request DonationRequest - reference of DonationRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return ModificationResult +*/ +func (a Payments) Donate(req *DonationRequest, ctxs ..._context.Context) (ModificationResult, *_nethttp.Response, error) { + res := &ModificationResult{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/donate", ctxs...) + return *res, httpRes, err } /* -GetAuthenticationResult Return the authentication result after doing a 3D Secure authentication only. +PostGetAuthenticationResult Return the authentication result after doing a 3D Secure authentication only. Return the authentication result after doing a 3D Secure authentication only. - * @param request AuthenticationResultRequest - reference of AuthenticationResultRequest). + * @param request AuthenticationResultRequest - reference of AuthenticationResultRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return AuthenticationResultResponse */ func (a Payments) GetAuthenticationResult(req *AuthenticationResultRequest, ctxs ..._context.Context) (AuthenticationResultResponse, *_nethttp.Response, error) { - res := &AuthenticationResultResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/getAuthenticationResult", ctxs...) - return *res, httpRes, err + res := &AuthenticationResultResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/getAuthenticationResult", ctxs...) + return *res, httpRes, err } /* -Refund Refunds a captured payment. +PostRefund Refunds a captured payment. Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead. > Some payment methods/gateways do not support partial/multiple refunds. > A margin above the captured limit can be configured to cover shipping/handling costs. For more information, refer to [Refund](https://docs.adyen.com/checkout/refund). - * @param request ModificationRequest - reference of ModificationRequest). + * @param request ModificationRequest - reference of ModificationRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ModificationResult */ func (a Payments) Refund(req *ModificationRequest, ctxs ..._context.Context) (ModificationResult, *_nethttp.Response, error) { - res := &ModificationResult{} - setModificationRequestApplicationInfo(req) - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/refund", ctxs...) - return *res, httpRes, err + res := &ModificationResult{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/refund", ctxs...) + return *res, httpRes, err } /* -Retrieve3ds2Result Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. +PostRetrieve3ds2Result Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. - * @param request ThreeDS2ResultRequest - reference of ThreeDS2ResultRequest). + * @param request ThreeDS2ResultRequest - reference of ThreeDS2ResultRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ThreeDS2ResultResponse */ func (a Payments) Retrieve3ds2Result(req *ThreeDS2ResultRequest, ctxs ..._context.Context) (ThreeDS2ResultResponse, *_nethttp.Response, error) { - res := &ThreeDS2ResultResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/retrieve3ds2Result", ctxs...) - return *res, httpRes, err + res := &ThreeDS2ResultResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/retrieve3ds2Result", ctxs...) + return *res, httpRes, err } /* -TechnicalCancel Cancels a payment using your custom reference. +PostTechnicalCancel Cancels a payment using your custom reference. This endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available. In your call, refer to the original payment by using the `reference` that you specified in your payment request. For more information, see [Technical cancel](https://docs.adyen.com/checkout/cancel#technical-cancel). - * @param request ModificationRequest - reference of ModificationRequest). + * @param request ModificationRequest - reference of ModificationRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ModificationResult */ func (a Payments) TechnicalCancel(req *ModificationRequest, ctxs ..._context.Context) (ModificationResult, *_nethttp.Response, error) { - res := &ModificationResult{} - setModificationRequestApplicationInfo(req) - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/technicalCancel", ctxs...) - return *res, httpRes, err + res := &ModificationResult{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/technicalCancel", ctxs...) + return *res, httpRes, err } /* -VoidPendingRefund Cancels a POS refund request before it has been completed. +PostVoidPendingRefund Cancels a POS refund request before it has been completed. This endpoint allows you to cancel the refund request before it has been completed. In your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions. For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request). - * @param request ModificationRequest - reference of ModificationRequest). + * @param request ModificationRequest - reference of ModificationRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ModificationResult */ func (a Payments) VoidPendingRefund(req *ModificationRequest, ctxs ..._context.Context) (ModificationResult, *_nethttp.Response, error) { - res := &ModificationResult{} - setModificationRequestApplicationInfo(req) - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/voidPendingRefund", ctxs...) - return *res, httpRes, err + res := &ModificationResult{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/voidPendingRefund", ctxs...) + return *res, httpRes, err } diff --git a/src/payments/model_account_info.go b/src/payments/model_account_info.go index 0d8a4f868..5480d6afd 100644 --- a/src/payments/model_account_info.go +++ b/src/payments/model_account_info.go @@ -1,19 +1,17 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - import ( "time" ) - // AccountInfo struct for AccountInfo type AccountInfo struct { // Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days diff --git a/src/payments/model_additional_data3_d_secure.go b/src/payments/model_additional_data3_d_secure.go index f17d846a1..c9b7d4a2a 100644 --- a/src/payments/model_additional_data3_d_secure.go +++ b/src/payments/model_additional_data3_d_secure.go @@ -1,23 +1,24 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalData3DSecure struct for AdditionalData3DSecure type AdditionalData3DSecure struct { - // This parameter indicates that you are able to process 3D Secure 2 transactions natively on your payment page. Send this field when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/checkout/3d-secure/native-3ds2), such as Components or Drop-in. Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration. > This parameter only indicates your readiness to support 3D Secure 2 natively on Drop-in or Components. To specify that you want to perform 3D Secure on a transaction, use Dynamic 3D Secure or send the executeThreeD parameter. + // Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/checkout/3d-secure/native-3ds2). > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter. Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration. Allow3DS2 string `json:"allow3DS2,omitempty"` - // This parameter indicates if you want to perform 3D Secure authentication on a transaction or not. Allowed values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. > Alternatively, you can also use Dynamic 3D Secure to configure rules for applying 3D Secure. + // Indicates if you want to perform 3D Secure authentication on a transaction. > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure. Possible values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. ExecuteThreeD string `json:"executeThreeD,omitempty"` // In case of Secure+, this field must be set to **CUPSecurePlus**. MpiImplementationType string `json:"mpiImplementationType,omitempty"` - // Indicates the [exemption type](https://docs-admin.is.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** + // Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** ScaExemption string `json:"scaExemption,omitempty"` + // Indicates your preference for the 3D Secure version. > If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure. Possible values: * **1.0.2**: Apply 3D Secure version 1.0.2. * **2.1.0**: Apply 3D Secure version 2.1.0. * **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0. The following rules apply: * If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2. * If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error. + ThreeDSVersion string `json:"threeDSVersion,omitempty"` } diff --git a/src/payments/model_additional_data_airline.go b/src/payments/model_additional_data_airline.go index b6e2b76f3..eb97b9e72 100644 --- a/src/payments/model_additional_data_airline.go +++ b/src/payments/model_additional_data_airline.go @@ -1,71 +1,70 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataAirline struct for AdditionalDataAirline type AdditionalDataAirline struct { - // Passenger name, initials, and a title. * Format: last name + first name or initials + title. * Example: *FLYER / MARY MS*. * minLength: 1 * maxLength: 49 - AirlinePassengerName string `json:"airline.passenger_name"` - // The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. * Format: alphanumeric. * minLength: 4 * maxLength: 4 - AirlineComputerizedReservationSystem string `json:"airline.computerized_reservation_system,omitempty"` + // Reference number for the invoice, issued by the agency. * minLength: 1 * maxLength: 6 + AirlineAgencyInvoiceNumber string `json:"airline.agency_invoice_number,omitempty"` + // 2-letter agency plan identifier; alphabetical. * minLength: 2 * maxLength: 2 + AirlineAgencyPlanName string `json:"airline.agency_plan_name,omitempty"` // [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier. * Format: IATA 3-digit accounting code (PAX) * Example: KLM = 074 * minLength: 3 * maxLength: 3 AirlineAirlineCode string `json:"airline.airline_code,omitempty"` - // The ticket's unique identifier. * minLength: 1 * maxLength: 150 - AirlineTicketNumber string `json:"airline.ticket_number,omitempty"` - // Flight departure date. Local time `(HH:mm)` is optional. * Date format: `yyyy-MM-dd` * Date and time format: `yyyy-MM-dd HH:mm` * minLength: 10 * maxLength: 16 - AirlineFlightDate string `json:"airline.flight_date,omitempty"` - // Reference number; alphanumeric. * minLength: 0 * maxLength: 20 - AirlineCustomerReferenceNumber string `json:"airline.customer_reference_number,omitempty"` - // Address of the place/agency that issued the ticket. * minLength: 0 * maxLength: 16 - AirlineTicketIssueAddress string `json:"airline.ticket_issue_address,omitempty"` // [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier. * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code * Example: KLM = KL * minLength: 2 * maxLength: 2 AirlineAirlineDesignatorCode string `json:"airline.airline_designator_code,omitempty"` - // IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies. * minLength: 1 * maxLength: 8 - AirlineTravelAgencyCode string `json:"airline.travel_agency_code,omitempty"` - // The name of the travel agency. * minLength: 1 * maxLength: 25 - AirlineTravelAgencyName string `json:"airline.travel_agency_name,omitempty"` - // 2-letter agency plan identifier; alphabetical. * minLength: 2 * maxLength: 2 - AirlineAgencyPlanName string `json:"airline.agency_plan_name,omitempty"` - // Reference number for the invoice, issued by the agency. * minLength: 1 * maxLength: 6 - AirlineAgencyInvoiceNumber string `json:"airline.agency_invoice_number,omitempty"` // Chargeable amount for boarding the plane. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). * minLength: 1 * maxLength: 18 AirlineBoardingFee string `json:"airline.boarding_fee,omitempty"` + // The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. * Format: alphanumeric. * minLength: 4 * maxLength: 4 + AirlineComputerizedReservationSystem string `json:"airline.computerized_reservation_system,omitempty"` + // Reference number; alphanumeric. * minLength: 0 * maxLength: 20 + AirlineCustomerReferenceNumber string `json:"airline.customer_reference_number,omitempty"` // Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements. * Format: 2-digit code * Example: Passenger ticket = 01 * minLength: 2 * maxLength: 2 AirlineDocumentType string `json:"airline.document_type,omitempty"` - // Alphabetical identifier of the departure airport. This field is required if the airline data includes leg details. * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. * Example: Amsterdam = AMS * minLength: 3 * maxLength: 3 - AirlineLegDepartAirport string `json:"airline.leg.depart_airport,omitempty"` - // The flight identifier. * minLength: 1 * maxLength: 5 - AirlineLegFlightNumber string `json:"airline.leg.flight_number,omitempty"` + // Flight departure date. Local time `(HH:mm)` is optional. * Date format: `yyyy-MM-dd` * Date and time format: `yyyy-MM-dd HH:mm` * minLength: 10 * maxLength: 16 + AirlineFlightDate string `json:"airline.flight_date,omitempty"` // [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier. This field is required/mandatory if the airline data includes leg details. * Format: IATA 2-letter airline code * Example: KLM = KL * minLength: 2 * maxLength: 2 AirlineLegCarrierCode string `json:"airline.leg.carrier_code,omitempty"` - // [Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric. * minLength: 1 * maxLength: 7 - AirlineLegFareBaseCode string `json:"airline.leg.fare_base_code,omitempty"` // 1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently: * F: first class * J: business class * Y: economy class * W: premium economy Limitations: * minLength: 1 * maxLength: 1 AirlineLegClassOfTravel string `json:"airline.leg.class_of_travel,omitempty"` - // 1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed: * O: Stopover allowed * X: Stopover not allowed Limitations: * minLength: 1 * maxLength: 1 - AirlineLegStopOverCode string `json:"airline.leg.stop_over_code,omitempty"` - // Alphabetical identifier of the destination/arrival airport. This field is required/mandatory if the airline data includes leg details. * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. * Example: Amsterdam = AMS * minLength: 3 * maxLength: 3 - AirlineLegDestinationCode string `json:"airline.leg.destination_code,omitempty"` // Date and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant. * Format: `yyyy-MM-dd HH:mm` * minLength: 16 * maxLength: 16 AirlineLegDateOfTravel string `json:"airline.leg.date_of_travel,omitempty"` + // Alphabetical identifier of the departure airport. This field is required if the airline data includes leg details. * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. * Example: Amsterdam = AMS * minLength: 3 * maxLength: 3 + AirlineLegDepartAirport string `json:"airline.leg.depart_airport,omitempty"` // [Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). * minLength: 1 * maxLength: 12 AirlineLegDepartTax string `json:"airline.leg.depart_tax,omitempty"` + // Alphabetical identifier of the destination/arrival airport. This field is required/mandatory if the airline data includes leg details. * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code. * Example: Amsterdam = AMS * minLength: 3 * maxLength: 3 + AirlineLegDestinationCode string `json:"airline.leg.destination_code,omitempty"` + // [Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric. * minLength: 1 * maxLength: 7 + AirlineLegFareBaseCode string `json:"airline.leg.fare_base_code,omitempty"` + // The flight identifier. * minLength: 1 * maxLength: 5 + AirlineLegFlightNumber string `json:"airline.leg.flight_number,omitempty"` + // 1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed: * O: Stopover allowed * X: Stopover not allowed Limitations: * minLength: 1 * maxLength: 1 + AirlineLegStopOverCode string `json:"airline.leg.stop_over_code,omitempty"` + // Date of birth of the passenger. Date format: `yyyy-MM-dd` * minLength: 10 * maxLength: 10 + AirlinePassengerDateOfBirth string `json:"airline.passenger.date_of_birth,omitempty"` // Passenger first name/given name. > This field is required/mandatory if the airline data includes passenger details or leg details. AirlinePassengerFirstName string `json:"airline.passenger.first_name,omitempty"` // Passenger last name/family name. > This field is required/mandatory if the airline data includes passenger details or leg details. AirlinePassengerLastName string `json:"airline.passenger.last_name,omitempty"` - // Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS. However, several carriers use non-standard codes that can be up to 5 alphanumeric characters. * minLength: 3 * maxLength: 6 - AirlinePassengerTravellerType string `json:"airline.passenger.traveller_type,omitempty"` // Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs. * minLength: 3 * maxLength: 30 AirlinePassengerTelephoneNumber string `json:"airline.passenger.telephone_number,omitempty"` - // Date of birth of the passenger. Date format: `yyyy-MM-dd` * minLength: 10 * maxLength: 10 - AirlinePassengerDateOfBirth string `json:"airline.passenger.date_of_birth,omitempty"` + // Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS. However, several carriers use non-standard codes that can be up to 5 alphanumeric characters. * minLength: 3 * maxLength: 6 + AirlinePassengerTravellerType string `json:"airline.passenger.traveller_type,omitempty"` + // Passenger name, initials, and a title. * Format: last name + first name or initials + title. * Example: *FLYER / MARY MS*. * minLength: 1 * maxLength: 49 + AirlinePassengerName string `json:"airline.passenger_name"` + // Address of the place/agency that issued the ticket. * minLength: 0 * maxLength: 16 + AirlineTicketIssueAddress string `json:"airline.ticket_issue_address,omitempty"` + // The ticket's unique identifier. * minLength: 1 * maxLength: 150 + AirlineTicketNumber string `json:"airline.ticket_number,omitempty"` + // IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies. * minLength: 1 * maxLength: 8 + AirlineTravelAgencyCode string `json:"airline.travel_agency_code,omitempty"` + // The name of the travel agency. * minLength: 1 * maxLength: 25 + AirlineTravelAgencyName string `json:"airline.travel_agency_name,omitempty"` } diff --git a/src/payments/model_additional_data_car_rental.go b/src/payments/model_additional_data_car_rental.go index 7a66a10fa..c9ca00e68 100644 --- a/src/payments/model_additional_data_car_rental.go +++ b/src/payments/model_additional_data_car_rental.go @@ -1,61 +1,60 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataCarRental struct for AdditionalDataCarRental type AdditionalDataCarRental struct { - // The rental agreement number associated with this car rental. * Format: Alphanumeric * maxLength: 14 - CarRentalRentalAgreementNumber string `json:"carRental.rentalAgreementNumber,omitempty"` - // The name of the person renting the car. * Format: Alphanumeric * maxLength: 26 - CarRentalRenterName string `json:"carRental.renterName,omitempty"` - // The city where the car must be returned. * Format: Alphanumeric * maxLength: 18 - CarRentalReturnCity string `json:"carRental.returnCity,omitempty"` - // The state or province where the car must be returned. * Format: Alphanumeric * maxLength: 3 - CarRentalReturnStateProvince string `json:"carRental.returnStateProvince,omitempty"` - // The country where the car must be returned. * Format: Alphanumeric * maxLength: 2 - CarRentalReturnCountry string `json:"carRental.returnCountry,omitempty"` - // Agency code, phone number, or address abbreviation * Format: Alphanumeric * maxLength: 10 - CarRentalReturnLocationId string `json:"carRental.returnLocationId,omitempty"` - // The last date to return the car by. * Date format: `yyyyMMdd` - CarRentalReturnDate string `json:"carRental.returnDate,omitempty"` // Pick-up date. * Date format: `yyyyMMdd` CarRentalCheckOutDate string `json:"carRental.checkOutDate,omitempty"` // The customer service phone number of the car rental company. * Format: Alphanumeric * maxLength: 17 CarRentalCustomerServiceTollFreeNumber string `json:"carRental.customerServiceTollFreeNumber,omitempty"` + // Number of days for which the car is being rented. * Format: Numeric * maxLength: 19 + CarRentalDaysRented string `json:"carRental.daysRented,omitempty"` + // Any fuel charges associated with the rental. * Format: Numeric * maxLength: 12 + CarRentalFuelCharges string `json:"carRental.fuelCharges,omitempty"` + // Any insurance charges associated with the rental. * Format: Numeric * maxLength: 12 + CarRentalInsuranceCharges string `json:"carRental.insuranceCharges,omitempty"` + // The city from which the car is rented. * Format: Alphanumeric * maxLength: 18 + CarRentalLocationCity string `json:"carRental.locationCity,omitempty"` + // The country from which the car is rented. * Format: Alphanumeric * maxLength: 2 + CarRentalLocationCountry string `json:"carRental.locationCountry,omitempty"` + // The state or province from where the car is rented. * Format: Alphanumeric * maxLength: 3 + CarRentalLocationStateProvince string `json:"carRental.locationStateProvince,omitempty"` + // Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking). * Y - Customer was a no show. * N - Not applicable. + CarRentalNoShowIndicator string `json:"carRental.noShowIndicator,omitempty"` + // Charge associated with not returning a vehicle to the original rental location. + CarRentalOneWayDropOffCharges string `json:"carRental.oneWayDropOffCharges,omitempty"` // Daily rental rate. * Format: Alphanumeric * maxLength: 12 CarRentalRate string `json:"carRental.rate,omitempty"` // Specifies whether the given rate is applied daily or weekly. * D - Daily rate. * W - Weekly rate. CarRentalRateIndicator string `json:"carRental.rateIndicator,omitempty"` - // The location from which the car is rented. * Format: Alphanumeric * maxLength: 18 - CarRentalLocationCity string `json:"carRental.locationCity,omitempty"` - // Pick-up date. * Date format: `yyyyMMdd` - CarRentalLocationStateProvince string `json:"carRental.locationStateProvince,omitempty"` - // The customer service phone number of the car rental company. * Format: Alphanumeric * maxLength: 17 - CarRentalLocationCountry string `json:"carRental.locationCountry,omitempty"` + // The rental agreement number associated with this car rental. * Format: Alphanumeric * maxLength: 9 + CarRentalRentalAgreementNumber string `json:"carRental.rentalAgreementNumber,omitempty"` // Daily rental rate. * Format: Alphanumeric * maxLength: 12 CarRentalRentalClassId string `json:"carRental.rentalClassId,omitempty"` - // Specifies whether the given rate is applied daily or weekly. * D - Daily rate. * W - Weekly rate. - CarRentalDaysRented string `json:"carRental.daysRented,omitempty"` - // Indicates whether the goods or services were tax-exempt, or tax was not collected. Values: * 0 - Tax was not collected * 1 - Goods or services were tax exempt + // The name of the person renting the car. * Format: Alphanumeric * maxLength: 26 + CarRentalRenterName string `json:"carRental.renterName,omitempty"` + // The city where the car must be returned. * Format: Alphanumeric * maxLength: 18 + CarRentalReturnCity string `json:"carRental.returnCity,omitempty"` + // The country where the car must be returned. * Format: Alphanumeric * maxLength: 2 + CarRentalReturnCountry string `json:"carRental.returnCountry,omitempty"` + // The last date to return the car by. * Date format: `yyyyMMdd` + CarRentalReturnDate string `json:"carRental.returnDate,omitempty"` + // Agency code, phone number, or address abbreviation * Format: Alphanumeric * maxLength: 10 + CarRentalReturnLocationId string `json:"carRental.returnLocationId,omitempty"` + // The state or province where the car must be returned. * Format: Alphanumeric * maxLength: 3 + CarRentalReturnStateProvince string `json:"carRental.returnStateProvince,omitempty"` + // Indicates whether the goods or services were tax-exempt, or tax was not collected. Values: * Y - Goods or services were tax exempt * N - Tax was not collected CarRentalTaxExemptIndicator string `json:"carRental.taxExemptIndicator,omitempty"` - // Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1 - TravelEntertainmentAuthDataMarket string `json:"travelEntertainmentAuthData.market,omitempty"` // Number of nights. This should be included in the auth message. * Format: Numeric * maxLength: 2 TravelEntertainmentAuthDataDuration string `json:"travelEntertainmentAuthData.duration,omitempty"` - // Any fuel charges associated with the rental. * Format: Numeric * maxLength: 12 - CarRentalFuelCharges string `json:"carRental.fuelCharges,omitempty"` - // Any insurance charges associated with the rental. * Format: Numeric * maxLength: 12 - CarRentalInsuranceCharges string `json:"carRental.insuranceCharges,omitempty"` - // Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking). * 0 - Not applicable. * 1 - Customer was a no show. - CarRentalNoShowIndicator string `json:"carRental.noShowIndicator,omitempty"` - // Charge associated with not returning a vehicle to the original rental location. - CarRentalOneWayDropOffCharges string `json:"carRental.oneWayDropOffCharges,omitempty"` + // Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1 + TravelEntertainmentAuthDataMarket string `json:"travelEntertainmentAuthData.market,omitempty"` } diff --git a/src/payments/model_additional_data_common.go b/src/payments/model_additional_data_common.go index 33c1b92a7..9f5c1f2d2 100644 --- a/src/payments/model_additional_data_common.go +++ b/src/payments/model_additional_data_common.go @@ -1,27 +1,42 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataCommon struct for AdditionalDataCommon type AdditionalDataCommon struct { + // Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response. + RequestedTestErrorResponseCode string `json:"RequestedTestErrorResponseCode,omitempty"` // Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/checkout/adjust-authorisation#authorisation-types). Allowed values: * **PreAuth** – flags the payment request to be handled as a pre-authorisation. * **FinalAuth** – flags the payment request to be handled as a final authorisation. AuthorisationType string `json:"authorisationType,omitempty"` // Allows you to determine or override the acquirer account that should be used for the transaction. If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new). CustomRoutingFlag string `json:"customRoutingFlag,omitempty"` - // Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardonFile** to ensure that the transaction is classified as MIT. + // In case of [asynchronous authorisation adjustment](https://docs.adyen.com/checkout/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made. Possible values: * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation. * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed. + IndustryUsage string `json:"industryUsage,omitempty"` + // Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT. NetworkTxReference string `json:"networkTxReference,omitempty"` // Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction. OverwriteBrand string `json:"overwriteBrand,omitempty"` - // Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response. - RequestedTestErrorResponseCode string `json:"RequestedTestErrorResponseCode,omitempty"` - // This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID, which is used by schemes to identify the merchant. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters. + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 13 characters. + SubMerchantCity string `json:"subMerchantCity,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. * Format: alpha-numeric. * Fixed length: 3 characters. + SubMerchantCountry string `json:"subMerchantCountry,omitempty"` + // This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters. SubMerchantID string `json:"subMerchantID,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. * Format: alpha-numeric. * Maximum length: 22 characters. + SubMerchantName string `json:"subMerchantName,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 10 characters. + SubMerchantPostalCode string `json:"subMerchantPostalCode,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 3 characters. + SubMerchantState string `json:"subMerchantState,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 60 characters. + SubMerchantStreet string `json:"subMerchantStreet,omitempty"` + // This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. * Format: alpha-numeric. * Fixed length: 11 or 14 characters. + SubMerchantTaxId string `json:"subMerchantTaxId,omitempty"` } diff --git a/src/payments/model_additional_data_level23.go b/src/payments/model_additional_data_level23.go index 59a20ec53..83619e020 100644 --- a/src/payments/model_additional_data_level23.go +++ b/src/payments/model_additional_data_level23.go @@ -1,49 +1,48 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataLevel23 struct for AdditionalDataLevel23 type AdditionalDataLevel23 struct { - // Customer code, if supplied by a customer. Encoding: ASCII. Max length: 25 characters. > Required for Level 2 and Level 3 data. + // Customer code, if supplied by a customer. Encoding: ASCII. Max length: 25 characters. > Required for Level 2 and Level 3 data. EnhancedSchemeDataCustomerReference string `json:"enhancedSchemeData.customerReference,omitempty"` - // Total tax amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. > Required for Level 2 and Level 3 data. - EnhancedSchemeDataTotalTaxAmount float32 `json:"enhancedSchemeData.totalTaxAmount,omitempty"` - // Shipping amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. - EnhancedSchemeDataFreightAmount float32 `json:"enhancedSchemeData.freightAmount,omitempty"` - // Duty amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. - EnhancedSchemeDataDutyAmount float32 `json:"enhancedSchemeData.dutyAmount,omitempty"` - // The postal code of a destination address. Encoding: ASCII. Max length: 10 characters. > Required for American Express. + // Destination country code. Encoding: ASCII. Max length: 3 characters. + EnhancedSchemeDataDestinationCountryCode string `json:"enhancedSchemeData.destinationCountryCode,omitempty"` + // The postal code of a destination address. Encoding: ASCII. Max length: 10 characters. > Required for American Express. EnhancedSchemeDataDestinationPostalCode string `json:"enhancedSchemeData.destinationPostalCode,omitempty"` // Destination state or province code. Encoding: ASCII.Max length: 3 characters. EnhancedSchemeDataDestinationStateProvinceCode string `json:"enhancedSchemeData.destinationStateProvinceCode,omitempty"` - // The postal code of a \"ship-from\" address. Encoding: ASCII. Max length: 10 characters. - EnhancedSchemeDataShipFromPostalCode string `json:"enhancedSchemeData.shipFromPostalCode,omitempty"` - // Destination country code. Encoding: ASCII. Max length: 3 characters. - EnhancedSchemeDataDestinationCountryCode string `json:"enhancedSchemeData.destinationCountryCode,omitempty"` - // Order date. * Format: `ddMMyy` Encoding: ASCII. Max length: 6 characters. - EnhancedSchemeDataOrderDate string `json:"enhancedSchemeData.orderDate,omitempty"` - // Item commodity code. Encoding: ASCII. Max length: 12 characters. + // Duty amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. + EnhancedSchemeDataDutyAmount string `json:"enhancedSchemeData.dutyAmount,omitempty"` + // Shipping amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. + EnhancedSchemeDataFreightAmount string `json:"enhancedSchemeData.freightAmount,omitempty"` + // Item commodity code. Encoding: ASCII. Max length: 12 characters. EnhancedSchemeDataItemDetailLineItemNrCommodityCode string `json:"enhancedSchemeData.itemDetailLine[itemNr].commodityCode,omitempty"` - // Item description. Encoding: ASCII. Max length: 26 characters. + // Item description. Encoding: ASCII. Max length: 26 characters. EnhancedSchemeDataItemDetailLineItemNrDescription string `json:"enhancedSchemeData.itemDetailLine[itemNr].description,omitempty"` - // Product code. Encoding: ASCII. Max length: 12 characters. + // Discount amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. + EnhancedSchemeDataItemDetailLineItemNrDiscountAmount string `json:"enhancedSchemeData.itemDetailLine[itemNr].discountAmount,omitempty"` + // Product code. Encoding: ASCII. Max length: 12 characters. EnhancedSchemeDataItemDetailLineItemNrProductCode string `json:"enhancedSchemeData.itemDetailLine[itemNr].productCode,omitempty"` - // Quantity, specified as an integer value. Value must be greater than 0. Max length: 12 characters. - EnhancedSchemeDataItemDetailLineItemNrQuantity float32 `json:"enhancedSchemeData.itemDetailLine[itemNr].quantity,omitempty"` - // Item unit of measurement. Encoding: ASCII. Max length: 3 characters. + // Quantity, specified as an integer value. Value must be greater than 0. Max length: 12 characters. + EnhancedSchemeDataItemDetailLineItemNrQuantity string `json:"enhancedSchemeData.itemDetailLine[itemNr].quantity,omitempty"` + // Total amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. + EnhancedSchemeDataItemDetailLineItemNrTotalAmount string `json:"enhancedSchemeData.itemDetailLine[itemNr].totalAmount,omitempty"` + // Item unit of measurement. Encoding: ASCII. Max length: 3 characters. EnhancedSchemeDataItemDetailLineItemNrUnitOfMeasure string `json:"enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure,omitempty"` - // Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). Max length: 12 characters. - EnhancedSchemeDataItemDetailLineItemNrUnitPrice float32 `json:"enhancedSchemeData.itemDetailLine[itemNr].unitPrice,omitempty"` - // Discount amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. - EnhancedSchemeDataItemDetailLineItemNrDiscountAmount float32 `json:"enhancedSchemeData.itemDetailLine[itemNr].discountAmount,omitempty"` - // Total amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. - EnhancedSchemeDataItemDetailLineItemNrTotalAmount float32 `json:"enhancedSchemeData.itemDetailLine[itemNr].totalAmount,omitempty"` + // Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). Max length: 12 characters. + EnhancedSchemeDataItemDetailLineItemNrUnitPrice string `json:"enhancedSchemeData.itemDetailLine[itemNr].unitPrice,omitempty"` + // Order date. * Format: `ddMMyy` Encoding: ASCII. Max length: 6 characters. + EnhancedSchemeDataOrderDate string `json:"enhancedSchemeData.orderDate,omitempty"` + // The postal code of a \"ship-from\" address. Encoding: ASCII. Max length: 10 characters. + EnhancedSchemeDataShipFromPostalCode string `json:"enhancedSchemeData.shipFromPostalCode,omitempty"` + // Total tax amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters. > Required for Level 2 and Level 3 data. + EnhancedSchemeDataTotalTaxAmount string `json:"enhancedSchemeData.totalTaxAmount,omitempty"` } diff --git a/src/payments/model_additional_data_lodging.go b/src/payments/model_additional_data_lodging.go index be861704b..6071fe898 100644 --- a/src/payments/model_additional_data_lodging.go +++ b/src/payments/model_additional_data_lodging.go @@ -1,49 +1,48 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataLodging struct for AdditionalDataLodging type AdditionalDataLodging struct { - // The toll free phone number for the hotel/lodgings. * Format: Alphanumeric * maxLength: 17 - LodgingCustomerServiceTollFreeNumber string `json:"lodging.customerServiceTollFreeNumber,omitempty"` // The arrival date. * Date format: `yyyyMMdd` LodgingCheckInDate string `json:"lodging.checkInDate,omitempty"` // The departure date. * Date format: `yyyyMMdd` LodgingCheckOutDate string `json:"lodging.checkOutDate,omitempty"` - // Card acceptor’s internal invoice or billing ID reference number. * Format: Alphanumeric * maxLength: 25 - LodgingFolioNumber string `json:"lodging.folioNumber,omitempty"` - // Identifies specific lodging property location by its local phone number. * Format: Alphanumeric * maxLength: 17 - LodgingPropertyPhoneNumber string `json:"lodging.propertyPhoneNumber,omitempty"` - // The rate of the room. * Format: Numeric * maxLength: 12 - LodgingRoom1Rate string `json:"lodging.room1.rate,omitempty"` - // The total amount of tax to be paid. * Format: Numeric * maxLength: 12 - LodgingRoom1Tax string `json:"lodging.room1.tax,omitempty"` - // Total number of nights the room will be rented. * Format: Numeric * maxLength: 4 - LodgingRoom1NumberOfNights string `json:"lodging.room1.numberOfNights,omitempty"` + // The toll free phone number for the hotel/lodgings. * Format: Alphanumeric * maxLength: 17 + LodgingCustomerServiceTollFreeNumber string `json:"lodging.customerServiceTollFreeNumber,omitempty"` // Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'. * Format: Alphabetic * maxLength: 1 LodgingFireSafetyActIndicator string `json:"lodging.fireSafetyActIndicator,omitempty"` - // Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1 - TravelEntertainmentAuthDataMarket string `json:"travelEntertainmentAuthData.market,omitempty"` - // Number of nights. This should be included in the auth message. * Format: Numeric * maxLength: 2 - TravelEntertainmentAuthDataDuration string `json:"travelEntertainmentAuthData.duration,omitempty"` // The folio cash advances. * Format: Numeric * maxLength: 12 LodgingFolioCashAdvances string `json:"lodging.folioCashAdvances,omitempty"` + // Card acceptor’s internal invoice or billing ID reference number. * Format: Alphanumeric * maxLength: 25 + LodgingFolioNumber string `json:"lodging.folioNumber,omitempty"` // Any charges for food and beverages associated with the booking. * Format: Numeric * maxLength: 12 LodgingFoodBeverageCharges string `json:"lodging.foodBeverageCharges,omitempty"` // Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking). Value should be Y or N. * Format: Numeric * maxLength: 1 LodgingNoShowIndicator string `json:"lodging.noShowIndicator,omitempty"` // Prepaid expenses for the booking. * Format: Numeric * maxLength: 12 LodgingPrepaidExpenses string `json:"lodging.prepaidExpenses,omitempty"` - // Total tax amount. * Format: Numeric * maxLength: 12 - LodgingTotalTax string `json:"lodging.totalTax,omitempty"` + // Identifies specific lodging property location by its local phone number. * Format: Alphanumeric * maxLength: 17 + LodgingPropertyPhoneNumber string `json:"lodging.propertyPhoneNumber,omitempty"` + // Total number of nights the room will be rented. * Format: Numeric * maxLength: 4 + LodgingRoom1NumberOfNights string `json:"lodging.room1.numberOfNights,omitempty"` + // The rate of the room. * Format: Numeric * maxLength: 12 + LodgingRoom1Rate string `json:"lodging.room1.rate,omitempty"` + // The total amount of tax to be paid. * Format: Numeric * maxLength: 12 + LodgingRoom1Tax string `json:"lodging.room1.tax,omitempty"` // Total room tax amount. * Format: Numeric * maxLength: 12 LodgingTotalRoomTax string `json:"lodging.totalRoomTax,omitempty"` + // Total tax amount. * Format: Numeric * maxLength: 12 + LodgingTotalTax string `json:"lodging.totalTax,omitempty"` + // Number of nights. This should be included in the auth message. * Format: Numeric * maxLength: 2 + TravelEntertainmentAuthDataDuration string `json:"travelEntertainmentAuthData.duration,omitempty"` + // Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1 + TravelEntertainmentAuthDataMarket string `json:"travelEntertainmentAuthData.market,omitempty"` } diff --git a/src/payments/model_additional_data_modifications.go b/src/payments/model_additional_data_modifications.go index f3c634fca..801aeed42 100644 --- a/src/payments/model_additional_data_modifications.go +++ b/src/payments/model_additional_data_modifications.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataModifications struct for AdditionalDataModifications type AdditionalDataModifications struct { // This is the installment option selected by the shopper. It is required only if specified by the user. diff --git a/src/payments/model_additional_data_open_invoice.go b/src/payments/model_additional_data_open_invoice.go index 58db30940..aa5d28c4d 100644 --- a/src/payments/model_additional_data_open_invoice.go +++ b/src/payments/model_additional_data_open_invoice.go @@ -1,35 +1,34 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataOpenInvoice struct for AdditionalDataOpenInvoice type AdditionalDataOpenInvoice struct { - // The number of invoice lines included in `openinvoicedata`. There needs to be at least one line, so `numberOfLines` needs to be at least 1. - OpeninvoicedataNumberOfLines int32 `json:"openinvoicedata.numberOfLines,omitempty"` // Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string. The `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end. Since the field is optional, if it's not included it does not impact computing the merchant signature. Applies only to Klarna. You can contact Klarna for the format and structure of the string. OpeninvoicedataMerchantData string `json:"openinvoicedata.merchantData,omitempty"` + // The number of invoice lines included in `openinvoicedata`. There needs to be at least one line, so `numberOfLines` needs to be at least 1. + OpeninvoicedataNumberOfLines string `json:"openinvoicedata.numberOfLines,omitempty"` // The three-character ISO currency code. - OpeninvoicedataLineItemNrCurrencyCode string `json:"openinvoicedata.line[itemNr].currencyCode,omitempty"` + OpeninvoicedataLineItemNrCurrencyCode string `json:"openinvoicedataLine[itemNr].currencyCode,omitempty"` // A text description of the product the invoice line refers to. - OpeninvoicedataLineItemNrDescription string `json:"openinvoicedata.line[itemNr].description,omitempty"` + OpeninvoicedataLineItemNrDescription string `json:"openinvoicedataLine[itemNr].description,omitempty"` // The price for one item in the invoice line, represented in minor units. The due amount for the item, VAT excluded. - OpeninvoicedataLineItemNrItemAmount int32 `json:"openinvoicedata.line[itemNr].itemAmount,omitempty"` + OpeninvoicedataLineItemNrItemAmount string `json:"openinvoicedataLine[itemNr].itemAmount,omitempty"` + // A unique id for this item. Required for RatePay if the description of each item is not unique. + OpeninvoicedataLineItemNrItemId string `json:"openinvoicedataLine[itemNr].itemId,omitempty"` // The VAT due for one item in the invoice line, represented in minor units. - OpeninvoicedataLineItemNrItemVatAmount int32 `json:"openinvoicedata.line[itemNr].itemVatAmount,omitempty"` + OpeninvoicedataLineItemNrItemVatAmount string `json:"openinvoicedataLine[itemNr].itemVatAmount,omitempty"` // The VAT percentage for one item in the invoice line, represented in minor units. For example, 19% VAT is specified as 1900. - OpeninvoicedataLineItemNrItemVatPercentage int32 `json:"openinvoicedata.line[itemNr].itemVatPercentage,omitempty"` - // A unique id for this item. Required for RatePay if the description of each item is not unique. - OpeninvoicedataLineItemNrItemId string `json:"openinvoicedata.line[itemNr].itemId,omitempty"` + OpeninvoicedataLineItemNrItemVatPercentage string `json:"openinvoicedataLine[itemNr].itemVatPercentage,omitempty"` // The number of units purchased of a specific product. - OpeninvoicedataLineItemNrNumberOfItems int32 `json:"openinvoicedata.line[itemNr].numberOfItems,omitempty"` + OpeninvoicedataLineItemNrNumberOfItems string `json:"openinvoicedataLine[itemNr].numberOfItems,omitempty"` // Required for AfterPay. The country-specific VAT category a product falls under. Allowed values: * High * Low * None. - OpeninvoicedataLineItemNrVatCategory string `json:"openinvoicedata.line[itemNr].vatCategory,omitempty"` + OpeninvoicedataLineItemNrVatCategory string `json:"openinvoicedataLine[itemNr].vatCategory,omitempty"` } diff --git a/src/payments/model_additional_data_opi.go b/src/payments/model_additional_data_opi.go new file mode 100644 index 000000000..c952bc642 --- /dev/null +++ b/src/payments/model_additional_data_opi.go @@ -0,0 +1,16 @@ +/* + * Adyen Payment API + * + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` + * + * API version: 64 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package payments +// AdditionalDataOpi struct for AdditionalDataOpi +type AdditionalDataOpi struct { + // Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response. You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + OpiIncludeTransToken string `json:"opi.includeTransToken,omitempty"` +} diff --git a/src/payments/model_additional_data_ratepay.go b/src/payments/model_additional_data_ratepay.go index 014179c89..d254b7fdb 100644 --- a/src/payments/model_additional_data_ratepay.go +++ b/src/payments/model_additional_data_ratepay.go @@ -1,31 +1,30 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataRatepay struct for AdditionalDataRatepay type AdditionalDataRatepay struct { // Amount the customer has to pay each month. - RatepayInstallmentAmount int32 `json:"ratepay.installmentAmount,omitempty"` + RatepayInstallmentAmount string `json:"ratepay.installmentAmount,omitempty"` + // Interest rate of this installment. + RatepayInterestRate string `json:"ratepay.interestRate,omitempty"` // Amount of the last installment. - RatepayLastInstallmentAmount int32 `json:"ratepay.lastInstallmentAmount,omitempty"` - // Interest rate of this installment. Double - RatepayInterestRate int32 `json:"ratepay.interestRate,omitempty"` + RatepayLastInstallmentAmount string `json:"ratepay.lastInstallmentAmount,omitempty"` // Calendar day of the first payment. - RatepayPaymentFirstday int32 `json:"ratepay.paymentFirstday,omitempty"` - // Identification name or number for the invoice, defined by the merchant. - RatepaydataInvoiceId string `json:"ratepaydata.invoiceId,omitempty"` - // Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date. - RatepaydataInvoiceDate string `json:"ratepaydata.invoiceDate,omitempty"` + RatepayPaymentFirstday string `json:"ratepay.paymentFirstday,omitempty"` // Date the merchant delivered the goods to the customer. RatepaydataDeliveryDate string `json:"ratepaydata.deliveryDate,omitempty"` // Date by which the customer must settle the payment. RatepaydataDueDate string `json:"ratepaydata.dueDate,omitempty"` + // Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date. + RatepaydataInvoiceDate string `json:"ratepaydata.invoiceDate,omitempty"` + // Identification name or number for the invoice, defined by the merchant. + RatepaydataInvoiceId string `json:"ratepaydata.invoiceId,omitempty"` } diff --git a/src/payments/model_additional_data_retry.go b/src/payments/model_additional_data_retry.go index 21de907d4..7aea96d3f 100644 --- a/src/payments/model_additional_data_retry.go +++ b/src/payments/model_additional_data_retry.go @@ -1,21 +1,20 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataRetry struct for AdditionalDataRetry type AdditionalDataRetry struct { - // The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - RetryChainAttemptNumber int32 `json:"retry.chainAttemptNumber,omitempty"` - // The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - RetryOrderAttemptNumber int32 `json:"retry.orderAttemptNumber,omitempty"` - // The Boolean value indicating whether Adyen should skip or retry this transaction, if possible. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. - RetrySkipRetry bool `json:"retry.skipRetry,omitempty"` + // The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + RetryChainAttemptNumber string `json:"retry.chainAttemptNumber,omitempty"` + // The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + RetryOrderAttemptNumber string `json:"retry.orderAttemptNumber,omitempty"` + // The Boolean value indicating whether Adyen should skip or retry this transaction, if possible. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + RetrySkipRetry string `json:"retry.skipRetry,omitempty"` } diff --git a/src/payments/model_additional_data_risk.go b/src/payments/model_additional_data_risk.go index fa205c7de..a1bc4794d 100644 --- a/src/payments/model_additional_data_risk.go +++ b/src/payments/model_additional_data_risk.go @@ -1,53 +1,52 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataRisk struct for AdditionalDataRisk type AdditionalDataRisk struct { // The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). RiskdataCustomFieldName string `json:"riskdata.[customFieldName],omitempty"` - // ID of the item. - RiskdataBasketItemItemNrItemID string `json:"riskdata.basket.item[itemNr].itemID,omitempty"` - // A text description of the product the invoice line refers to. - RiskdataBasketItemItemNrProductTitle string `json:"riskdata.basket.item[itemNr].productTitle,omitempty"` // The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). RiskdataBasketItemItemNrAmountPerItem string `json:"riskdata.basket.item[itemNr].amountPerItem,omitempty"` - // The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - RiskdataBasketItemItemNrCurrency string `json:"riskdata.basket.item[itemNr].currency,omitempty"` - // [Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code). - RiskdataBasketItemItemNrUpc string `json:"riskdata.basket.item[itemNr].upc,omitempty"` - // [Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit). - RiskdataBasketItemItemNrSku string `json:"riskdata.basket.item[itemNr].sku,omitempty"` // Brand of the item. RiskdataBasketItemItemNrBrand string `json:"riskdata.basket.item[itemNr].brand,omitempty"` - // Manufacturer of the item. - RiskdataBasketItemItemNrManufacturer string `json:"riskdata.basket.item[itemNr].manufacturer,omitempty"` // Category of the item. RiskdataBasketItemItemNrCategory string `json:"riskdata.basket.item[itemNr].category,omitempty"` // Color of the item. RiskdataBasketItemItemNrColor string `json:"riskdata.basket.item[itemNr].color,omitempty"` - // Size of the item. - RiskdataBasketItemItemNrSize string `json:"riskdata.basket.item[itemNr].size,omitempty"` + // The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + RiskdataBasketItemItemNrCurrency string `json:"riskdata.basket.item[itemNr].currency,omitempty"` + // ID of the item. + RiskdataBasketItemItemNrItemID string `json:"riskdata.basket.item[itemNr].itemID,omitempty"` + // Manufacturer of the item. + RiskdataBasketItemItemNrManufacturer string `json:"riskdata.basket.item[itemNr].manufacturer,omitempty"` + // A text description of the product the invoice line refers to. + RiskdataBasketItemItemNrProductTitle string `json:"riskdata.basket.item[itemNr].productTitle,omitempty"` // Quantity of the item purchased. RiskdataBasketItemItemNrQuantity string `json:"riskdata.basket.item[itemNr].quantity,omitempty"` // Email associated with the given product in the basket (usually in electronic gift cards). RiskdataBasketItemItemNrReceiverEmail string `json:"riskdata.basket.item[itemNr].receiverEmail,omitempty"` + // Size of the item. + RiskdataBasketItemItemNrSize string `json:"riskdata.basket.item[itemNr].size,omitempty"` + // [Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit). + RiskdataBasketItemItemNrSku string `json:"riskdata.basket.item[itemNr].sku,omitempty"` + // [Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code). + RiskdataBasketItemItemNrUpc string `json:"riskdata.basket.item[itemNr].upc,omitempty"` // Code of the promotion. RiskdataPromotionsPromotionItemNrPromotionCode string `json:"riskdata.promotions.promotion[itemNr].promotionCode,omitempty"` - // Name of the promotion. - RiskdataPromotionsPromotionItemNrPromotionName string `json:"riskdata.promotions.promotion[itemNr].promotionName,omitempty"` // The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). RiskdataPromotionsPromotionItemNrPromotionDiscountAmount string `json:"riskdata.promotions.promotion[itemNr].promotionDiscountAmount,omitempty"` // The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). RiskdataPromotionsPromotionItemNrPromotionDiscountCurrency string `json:"riskdata.promotions.promotion[itemNr].promotionDiscountCurrency,omitempty"` // Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign. e.g. for a promotion discount of 30%, the value of the field should be 30. RiskdataPromotionsPromotionItemNrPromotionDiscountPercentage string `json:"riskdata.promotions.promotion[itemNr].promotionDiscountPercentage,omitempty"` + // Name of the promotion. + RiskdataPromotionsPromotionItemNrPromotionName string `json:"riskdata.promotions.promotion[itemNr].promotionName,omitempty"` } diff --git a/src/payments/model_additional_data_risk_standalone.go b/src/payments/model_additional_data_risk_standalone.go index d9a3cf4d6..0c843c744 100644 --- a/src/payments/model_additional_data_risk_standalone.go +++ b/src/payments/model_additional_data_risk_standalone.go @@ -1,17 +1,32 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataRiskStandalone struct for AdditionalDataRiskStandalone type AdditionalDataRiskStandalone struct { + // Shopper's country of residence in the form of ISO standard 3166 2-character country codes. + PayPalCountryCode string `json:"PayPal.CountryCode,omitempty"` + // Shopper's email. + PayPalEmailId string `json:"PayPal.EmailId,omitempty"` + // Shopper's first name. + PayPalFirstName string `json:"PayPal.FirstName,omitempty"` + // Shopper's last name. + PayPalLastName string `json:"PayPal.LastName,omitempty"` + // Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters. + PayPalPayerId string `json:"PayPal.PayerId,omitempty"` + // Shopper's phone number. + PayPalPhone string `json:"PayPal.Phone,omitempty"` + // Allowed values: * **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. * **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. * **Ineligible** — Merchant is not protected under the Seller Protection Policy. + PayPalProtectionEligibility string `json:"PayPal.ProtectionEligibility,omitempty"` + // Unique transaction ID of the payment. + PayPalTransactionId string `json:"PayPal.TransactionId,omitempty"` // Raw AVS result received from the acquirer, where available. Example: D AvsResultRaw string `json:"avsResultRaw,omitempty"` // The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). @@ -19,27 +34,11 @@ type AdditionalDataRiskStandalone struct { // Raw CVC result received from the acquirer, where available. Example: 1 CvcResultRaw string `json:"cvcResultRaw,omitempty"` // Unique identifier or token for the shopper's card details. - RiskToken string `json:"risk.token,omitempty"` + RiskToken string `json:"riskToken,omitempty"` // A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true ThreeDAuthenticated string `json:"threeDAuthenticated,omitempty"` // A Boolean value indicating whether 3DS was offered for this payment. Example: true ThreeDOffered string `json:"threeDOffered,omitempty"` // Required for PayPal payments only. The only supported value is: **paypal**. TokenDataType string `json:"tokenDataType,omitempty"` - // Allowed values: * **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. * **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. * **Ineligible** — Merchant is not protected under the Seller Protection Policy. - PayPalProtectionEligibility string `json:"PayPal.ProtectionEligibility,omitempty"` - // Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters. - PayPalPayerId string `json:"PayPal.PayerId,omitempty"` - // Unique transaction ID of the payment. - PayPalTransactionId string `json:"PayPal.TransactionId,omitempty"` - // Shopper's country of residence in the form of ISO standard 3166 2-character country codes. - PayPalCountryCode string `json:"PayPal.CountryCode,omitempty"` - // Shopper's first name. - PayPalFirstName string `json:"PayPal.FirstName,omitempty"` - // Shopper's last name. - PayPalLastName string `json:"PayPal.LastName,omitempty"` - // Shopper's phone number. - PayPalPhone string `json:"PayPal.Phone,omitempty"` - // Shopper's email. - PayPalEmailId string `json:"PayPal.EmailId,omitempty"` } diff --git a/src/payments/model_additional_data_temporary_services.go b/src/payments/model_additional_data_temporary_services.go index ee91ba894..1bd63f2a7 100644 --- a/src/payments/model_additional_data_temporary_services.go +++ b/src/payments/model_additional_data_temporary_services.go @@ -1,33 +1,32 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataTemporaryServices struct for AdditionalDataTemporaryServices type AdditionalDataTemporaryServices struct { // Customer code, if supplied by a customer. * Encoding: ASCII * maxLength: 25 EnhancedSchemeDataCustomerReference string `json:"enhancedSchemeData.customerReference,omitempty"` - // Total tax amount, in minor units. For example, 2000 means USD 20.00 * maxLength: 12 - EnhancedSchemeDataTotalTaxAmount string `json:"enhancedSchemeData.totalTaxAmount,omitempty"` // Name or ID associated with the individual working in a temporary capacity. * maxLength: 40 EnhancedSchemeDataEmployeeName string `json:"enhancedSchemeData.employeeName,omitempty"` // Description of the job or task of the individual working in a temporary capacity. * maxLength: 40 EnhancedSchemeDataJobDescription string `json:"enhancedSchemeData.jobDescription,omitempty"` + // Amount paid per regular hours worked, minor units. * maxLength: 7 + EnhancedSchemeDataRegularHoursRate string `json:"enhancedSchemeData.regularHoursRate,omitempty"` + // Amount of time worked during a normal operation for the task or job. * maxLength: 7 + EnhancedSchemeDataRegularHoursWorked string `json:"enhancedSchemeData.regularHoursWorked,omitempty"` + // Name of the individual requesting temporary services. * maxLength: 40 + EnhancedSchemeDataRequestName string `json:"enhancedSchemeData.requestName,omitempty"` // Date for the beginning of the pay period. * Format: ddMMyy * maxLength: 6 EnhancedSchemeDataTempStartDate string `json:"enhancedSchemeData.tempStartDate,omitempty"` // Date of the end of the billing cycle. * Format: ddMMyy * maxLength: 6 EnhancedSchemeDataTempWeekEnding string `json:"enhancedSchemeData.tempWeekEnding,omitempty"` - // Name of the individual requesting temporary services. * maxLength: 40 - EnhancedSchemeDataRequestName string `json:"enhancedSchemeData.requestName,omitempty"` - // Amount of time worked during a normal operation for the task or job. * maxLength: 7 - EnhancedSchemeDataRegularHoursWorked string `json:"enhancedSchemeData.regularHoursWorked,omitempty"` - // Amount paid per regular hours worked, minor units. * maxLength: 7 - EnhancedSchemeDataRegularHoursRate string `json:"enhancedSchemeData.regularHoursRate,omitempty"` + // Total tax amount, in minor units. For example, 2000 means USD 20.00 * maxLength: 12 + EnhancedSchemeDataTotalTaxAmount string `json:"enhancedSchemeData.totalTaxAmount,omitempty"` } diff --git a/src/payments/model_additional_data_wallets.go b/src/payments/model_additional_data_wallets.go index 442bcdc79..a513080fb 100644 --- a/src/payments/model_additional_data_wallets.go +++ b/src/payments/model_additional_data_wallets.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AdditionalDataWallets struct for AdditionalDataWallets type AdditionalDataWallets struct { // The Android Pay token retrieved from the SDK. diff --git a/src/payments/model_address.go b/src/payments/model_address.go index c59866810..c5f30392e 100644 --- a/src/payments/model_address.go +++ b/src/payments/model_address.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // Address struct for Address type Address struct { // The name of the city. diff --git a/src/payments/model_amount.go b/src/payments/model_amount.go index a6116646b..61298e87e 100644 --- a/src/payments/model_amount.go +++ b/src/payments/model_amount.go @@ -1,19 +1,18 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // Amount struct for Amount type Amount struct { // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). Currency string `json:"currency"` - // The payable amount that can be charged for the transaction. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + // The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). Value int64 `json:"value"` } diff --git a/src/payments/model_application_info.go b/src/payments/model_application_info.go index bc8e299f0..927dded92 100644 --- a/src/payments/model_application_info.go +++ b/src/payments/model_application_info.go @@ -1,21 +1,20 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ApplicationInfo struct for ApplicationInfo type ApplicationInfo struct { - AdyenLibrary *CommonField `json:"adyenLibrary,omitempty"` - AdyenPaymentSource *CommonField `json:"adyenPaymentSource,omitempty"` - ExternalPlatform *ExternalPlatform `json:"externalPlatform,omitempty"` - MerchantApplication *CommonField `json:"merchantApplication,omitempty"` - MerchantDevice *MerchantDevice `json:"merchantDevice,omitempty"` + AdyenLibrary *CommonField `json:"adyenLibrary,omitempty"` + AdyenPaymentSource *CommonField `json:"adyenPaymentSource,omitempty"` + ExternalPlatform *ExternalPlatform `json:"externalPlatform,omitempty"` + MerchantApplication *CommonField `json:"merchantApplication,omitempty"` + MerchantDevice *MerchantDevice `json:"merchantDevice,omitempty"` ShopperInteractionDevice *ShopperInteractionDevice `json:"shopperInteractionDevice,omitempty"` } diff --git a/src/payments/model_authentication_result_request.go b/src/payments/model_authentication_result_request.go index 869b99f43..4d99c9289 100644 --- a/src/payments/model_authentication_result_request.go +++ b/src/payments/model_authentication_result_request.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AuthenticationResultRequest struct for AuthenticationResultRequest type AuthenticationResultRequest struct { // The merchant account identifier, with which the authentication was processed. diff --git a/src/payments/model_authentication_result_response.go b/src/payments/model_authentication_result_response.go index bf7767b17..044b028bc 100644 --- a/src/payments/model_authentication_result_response.go +++ b/src/payments/model_authentication_result_response.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // AuthenticationResultResponse struct for AuthenticationResultResponse type AuthenticationResultResponse struct { ThreeDS1Result *ThreeDS1Result `json:"threeDS1Result,omitempty"` diff --git a/src/payments/model_bank_account.go b/src/payments/model_bank_account.go index 8bdc8da1d..126843f67 100644 --- a/src/payments/model_bank_account.go +++ b/src/payments/model_bank_account.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // BankAccount struct for BankAccount type BankAccount struct { // The bank account number (without separators). diff --git a/src/payments/model_browser_info.go b/src/payments/model_browser_info.go index b694dd6e9..67d006dad 100644 --- a/src/payments/model_browser_info.go +++ b/src/payments/model_browser_info.go @@ -1,20 +1,19 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // BrowserInfo struct for BrowserInfo type BrowserInfo struct { // The accept header value of the shopper's browser. AcceptHeader string `json:"acceptHeader"` - // The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 32 or 48 bit color depth. + // The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth. ColorDepth int32 `json:"colorDepth"` // Boolean value indicating if the shopper's browser is able to execute Java. JavaEnabled bool `json:"javaEnabled"` diff --git a/src/payments/model_card.go b/src/payments/model_card.go index 7df8b5c6d..752d9a356 100644 --- a/src/payments/model_card.go +++ b/src/payments/model_card.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // Card struct for Card type Card struct { // The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: * CVV2/CVC2 – length: 3 digits * CID – length: 4 digits > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). > When this value is returned in a response, it is always empty because it is not stored. diff --git a/src/payments/model_common_field.go b/src/payments/model_common_field.go index 11b14b929..85fda3e03 100644 --- a/src/payments/model_common_field.go +++ b/src/payments/model_common_field.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // CommonField struct for CommonField type CommonField struct { // Name of the field. For example, Name of External Platform. diff --git a/src/payments/model_device_render_options.go b/src/payments/model_device_render_options.go index e9be858b9..bb0bad961 100644 --- a/src/payments/model_device_render_options.go +++ b/src/payments/model_device_render_options.go @@ -1,18 +1,17 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // DeviceRenderOptions struct for DeviceRenderOptions type DeviceRenderOptions struct { - // Supported SDK interface types. Allowed values: * Native * Html * both + // Supported SDK interface types. Allowed values: * native * html * both SdkInterface string `json:"sdkInterface,omitempty"` // UI types supported for displaying specific challenges. Allowed values: * text * singleSelect * outOfBand * otherHtml * multiSelect SdkUiType []string `json:"sdkUiType,omitempty"` diff --git a/src/payments/model_donation_request.go b/src/payments/model_donation_request.go new file mode 100644 index 000000000..58efc04d2 --- /dev/null +++ b/src/payments/model_donation_request.go @@ -0,0 +1,23 @@ +/* + * Adyen Payment API + * + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` + * + * API version: 64 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package payments +// DonationRequest struct for DonationRequest +type DonationRequest struct { + // The Adyen account name of the charity. + DonationAccount string `json:"donationAccount"` + // The merchant account that is used to process the payment. + MerchantAccount string `json:"merchantAccount"` + ModificationAmount *Amount `json:"modificationAmount,omitempty"` + // The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification + OriginalReference string `json:"originalReference"` + // Optionally, you can specify your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. + Reference string `json:"reference,omitempty"` +} diff --git a/src/payments/model_external_platform.go b/src/payments/model_external_platform.go index aceaf704f..35e5aebbd 100644 --- a/src/payments/model_external_platform.go +++ b/src/payments/model_external_platform.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ExternalPlatform struct for ExternalPlatform type ExternalPlatform struct { // External platform integrator. diff --git a/src/payments/model_forex_quote.go b/src/payments/model_forex_quote.go index 9a6907ae7..cacddacd4 100644 --- a/src/payments/model_forex_quote.go +++ b/src/payments/model_forex_quote.go @@ -1,33 +1,31 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - import ( "time" ) - // ForexQuote struct for ForexQuote type ForexQuote struct { // The account name. Account string `json:"account,omitempty"` // The account type. - AccountType string `json:"accountType,omitempty"` - BaseAmount *Amount `json:"baseAmount,omitempty"` + AccountType string `json:"accountType,omitempty"` + BaseAmount *Amount `json:"baseAmount,omitempty"` // The base points. - BasePoints int32 `json:"basePoints"` - Buy *Amount `json:"buy,omitempty"` - Interbank *Amount `json:"interbank,omitempty"` + BasePoints int32 `json:"basePoints"` + Buy *Amount `json:"buy,omitempty"` + Interbank *Amount `json:"interbank,omitempty"` // The reference assigned to the forex quote request. - Reference string `json:"reference,omitempty"` - Sell *Amount `json:"sell,omitempty"` + Reference string `json:"reference,omitempty"` + Sell *Amount `json:"sell,omitempty"` // The signature to validate the integrity. Signature string `json:"signature,omitempty"` // The source of the forex quote. diff --git a/src/payments/model_fraud_check_result.go b/src/payments/model_fraud_check_result.go index 54aaa62d0..e66186480 100644 --- a/src/payments/model_fraud_check_result.go +++ b/src/payments/model_fraud_check_result.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // FraudCheckResult struct for FraudCheckResult type FraudCheckResult struct { // The fraud score generated by the risk check. diff --git a/src/payments/model_fraud_result.go b/src/payments/model_fraud_result.go index 95f1b15d4..3bf838ba2 100644 --- a/src/payments/model_fraud_result.go +++ b/src/payments/model_fraud_result.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // FraudResult struct for FraudResult type FraudResult struct { // The total fraud score generated by the risk checks. diff --git a/src/payments/model_installments.go b/src/payments/model_installments.go index e31218dd0..2d14d1119 100644 --- a/src/payments/model_installments.go +++ b/src/payments/model_installments.go @@ -1,17 +1,18 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // Installments struct for Installments type Installments struct { + // Defines the type of installment plan. If not set, defaults to **regular**. Possible values: * **regular** * **revolving** + Plan string `json:"plan,omitempty"` // Defines the number of installments. Its value needs to be greater than zero. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. Value int32 `json:"value"` } diff --git a/src/payments/model_merchant_device.go b/src/payments/model_merchant_device.go index 22300d062..fe6dd3d09 100644 --- a/src/payments/model_merchant_device.go +++ b/src/payments/model_merchant_device.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // MerchantDevice struct for MerchantDevice type MerchantDevice struct { // Operating system running on the merchant device. diff --git a/src/payments/model_merchant_risk_indicator.go b/src/payments/model_merchant_risk_indicator.go index 1f06888ce..607efc4b2 100644 --- a/src/payments/model_merchant_risk_indicator.go +++ b/src/payments/model_merchant_risk_indicator.go @@ -1,19 +1,17 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - import ( "time" ) - // MerchantRiskIndicator struct for MerchantRiskIndicator type MerchantRiskIndicator struct { // Whether the chosen delivery address is identical to the billing address. @@ -23,9 +21,9 @@ type MerchantRiskIndicator struct { // The delivery email address (for digital goods). DeliveryEmail string `json:"deliveryEmail,omitempty"` // The estimated delivery time for the shopper to receive the goods. Allowed values: * `electronicDelivery` * `sameDayShipping` * `overnightShipping` * `twoOrMoreDaysShipping` - DeliveryTimeframe string `json:"deliveryTimeframe,omitempty"` - GiftCardAmount *Amount `json:"giftCardAmount,omitempty"` - // Number of individual prepaid or gift cards used for this purchase. + DeliveryTimeframe string `json:"deliveryTimeframe,omitempty"` + GiftCardAmount *Amount `json:"giftCardAmount,omitempty"` + // For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. GiftCardCount int32 `json:"giftCardCount,omitempty"` // For pre-order purchases, the expected date this product will be available to the shopper. PreOrderDate *time.Time `json:"preOrderDate,omitempty"` diff --git a/src/payments/model_modification_request.go b/src/payments/model_modification_request.go index ea59c336c..0f2a37687 100644 --- a/src/payments/model_modification_request.go +++ b/src/payments/model_modification_request.go @@ -1,9 +1,9 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,17 +15,16 @@ type ModificationRequest struct { // This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value. AdditionalData interface{} `json:"additionalData,omitempty"` // The merchant account that is used to process the payment. - MerchantAccount string `json:"merchantAccount"` - ModificationAmount *Amount `json:"modificationAmount,omitempty"` - MpiData *ThreeDSecureData `json:"mpiData,omitempty"` - ApplicationInfo *ApplicationInfo `json:"applicationInfo,omitempty"` + MerchantAccount string `json:"merchantAccount"` + ModificationAmount *Amount `json:"modificationAmount,omitempty"` + MpiData *ThreeDSecureData `json:"mpiData,omitempty"` // The original merchant reference to cancel. OriginalMerchantReference string `json:"originalMerchantReference,omitempty"` // The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification OriginalReference string `json:"originalReference"` // Optionally, you can specify your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. Reference string `json:"reference,omitempty"` - // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). + // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). Splits *[]Split `json:"splits,omitempty"` // The transaction reference provided by the PED. For point-of-sale integrations only. TenderReference string `json:"tenderReference,omitempty"` diff --git a/src/payments/model_modification_result.go b/src/payments/model_modification_result.go index aa01c8f58..77e7c73c2 100644 --- a/src/payments/model_modification_result.go +++ b/src/payments/model_modification_result.go @@ -1,9 +1,9 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,7 +13,7 @@ package payments // ModificationResult struct for ModificationResult type ModificationResult struct { // This field contains additional data, which may be returned in a particular modification response. - AdditionalData interface{} `json:"additionalData,omitempty"` + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` // Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. PspReference string `json:"pspReference,omitempty"` // Indicates if the modification request has been received for processing. diff --git a/src/payments/model_name.go b/src/payments/model_name.go index c7c0ee9d6..373cb6a55 100644 --- a/src/payments/model_name.go +++ b/src/payments/model_name.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // Name struct for Name type Name struct { // The first name. diff --git a/src/payments/model_payment_request.go b/src/payments/model_payment_request.go index 7f5c8c3ac..a7932c771 100644 --- a/src/payments/model_payment_request.go +++ b/src/payments/model_payment_request.go @@ -1,9 +1,9 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,22 +16,22 @@ import ( // PaymentRequest struct for PaymentRequest type PaymentRequest struct { - AccountInfo *AccountInfo `json:"accountInfo,omitempty"` - AdditionalAmount *Amount `json:"additionalAmount,omitempty"` + AccountInfo *AccountInfo `json:"accountInfo,omitempty"` + AdditionalAmount *Amount `json:"additionalAmount,omitempty"` // This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. - AdditionalData interface{} `json:"additionalData,omitempty"` - Amount Amount `json:"amount"` + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` + Amount Amount `json:"amount"` ApplicationInfo *ApplicationInfo `json:"applicationInfo,omitempty"` - BankAccount *BankAccount `json:"bankAccount,omitempty"` - BillingAddress *Address `json:"billingAddress,omitempty"` - BrowserInfo *BrowserInfo `json:"browserInfo,omitempty"` + BankAccount *BankAccount `json:"bankAccount,omitempty"` + BillingAddress *Address `json:"billingAddress,omitempty"` + BrowserInfo *BrowserInfo `json:"browserInfo,omitempty"` // The delay between the authorisation and scheduled auto-capture, specified in hours. CaptureDelayHours int32 `json:"captureDelayHours,omitempty"` - Card *Card `json:"card,omitempty"` + Card *Card `json:"card,omitempty"` // The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD - DateOfBirth *time.Time `json:"dateOfBirth,omitempty"` - DccQuote *ForexQuote `json:"dccQuote,omitempty"` - DeliveryAddress *Address `json:"deliveryAddress,omitempty"` + DateOfBirth *time.Time `json:"dateOfBirth,omitempty"` + DccQuote *ForexQuote `json:"dccQuote,omitempty"` + DeliveryAddress *Address `json:"deliveryAddress,omitempty"` // The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 DeliveryDate *time.Time `json:"deliveryDate,omitempty"` // A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). @@ -42,25 +42,25 @@ type PaymentRequest struct { EntityType string `json:"entityType,omitempty"` // An integer value that is added to the normal fraud score. The value can be either positive or negative. FraudOffset int32 `json:"fraudOffset,omitempty"` - // How to process combo card (for some Brazilian cards only). Allowed values: * debit * credit - FundingSource string `json:"fundingSource,omitempty"` - Installments *Installments `json:"installments,omitempty"` + // The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + FundingSource string `json:"fundingSource,omitempty"` + Installments *Installments `json:"installments,omitempty"` // The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. Mcc string `json:"mcc,omitempty"` // The merchant account identifier, with which you want to process the transaction. MerchantAccount string `json:"merchantAccount"` // This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. - MerchantOrderReference string `json:"merchantOrderReference,omitempty"` - MerchantRiskIndicator *MerchantRiskIndicator `json:"merchantRiskIndicator,omitempty"` + MerchantOrderReference string `json:"merchantOrderReference,omitempty"` + MerchantRiskIndicator *MerchantRiskIndicator `json:"merchantRiskIndicator,omitempty"` // Metadata consists of entries, each of which includes a key and a value. Limitations: Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". - Metadata *map[string]interface{} `json:"metadata,omitempty"` - MpiData *ThreeDSecureData `json:"mpiData,omitempty"` + Metadata map[string]string `json:"metadata,omitempty"` + MpiData *ThreeDSecureData `json:"mpiData,omitempty"` // The two-character country code of the shopper's nationality. Nationality string `json:"nationality,omitempty"` // When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. - OrderReference string `json:"orderReference,omitempty"` - Recurring *Recurring `json:"recurring,omitempty"` - // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – Card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – A transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + OrderReference string `json:"orderReference,omitempty"` + Recurring *Recurring `json:"recurring,omitempty"` + // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. RecurringProcessingModel string `json:"recurringProcessingModel,omitempty"` // The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. Reference string `json:"reference"` @@ -78,19 +78,19 @@ type PaymentRequest struct { ShopperInteraction string `json:"shopperInteraction,omitempty"` // The combination of a language code and a country code to specify the language to be used in the payment. ShopperLocale string `json:"shopperLocale,omitempty"` - ShopperName *Name `json:"shopperName,omitempty"` - // The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments. + ShopperName *Name `json:"shopperName,omitempty"` + // Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. ShopperReference string `json:"shopperReference,omitempty"` - // The text to appear on the shopper's bank statement. + // The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. ShopperStatement string `json:"shopperStatement,omitempty"` // The shopper's social security number. SocialSecurityNumber string `json:"socialSecurityNumber,omitempty"` - // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). + // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). Splits *[]Split `json:"splits,omitempty"` // The physical store, for which this payment is processed. Store string `json:"store,omitempty"` // The shopper's telephone number. - TelephoneNumber string `json:"telephoneNumber,omitempty"` + TelephoneNumber string `json:"telephoneNumber,omitempty"` ThreeDS2RequestData *ThreeDS2RequestData `json:"threeDS2RequestData,omitempty"` // If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. ThreeDSAuthenticationOnly bool `json:"threeDSAuthenticationOnly,omitempty"` diff --git a/src/payments/model_payment_request3d.go b/src/payments/model_payment_request3d.go index abcb0eb63..264e44214 100644 --- a/src/payments/model_payment_request3d.go +++ b/src/payments/model_payment_request3d.go @@ -1,9 +1,9 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,20 +16,20 @@ import ( // PaymentRequest3d struct for PaymentRequest3d type PaymentRequest3d struct { - AccountInfo *AccountInfo `json:"accountInfo,omitempty"` - AdditionalAmount *Amount `json:"additionalAmount,omitempty"` + AccountInfo *AccountInfo `json:"accountInfo,omitempty"` + AdditionalAmount *Amount `json:"additionalAmount,omitempty"` // This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. - AdditionalData interface{} `json:"additionalData,omitempty"` - Amount *Amount `json:"amount,omitempty"` + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` + Amount *Amount `json:"amount,omitempty"` ApplicationInfo *ApplicationInfo `json:"applicationInfo,omitempty"` - BillingAddress *Address `json:"billingAddress,omitempty"` - BrowserInfo *BrowserInfo `json:"browserInfo,omitempty"` + BillingAddress *Address `json:"billingAddress,omitempty"` + BrowserInfo *BrowserInfo `json:"browserInfo,omitempty"` // The delay between the authorisation and scheduled auto-capture, specified in hours. CaptureDelayHours int32 `json:"captureDelayHours,omitempty"` // The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD - DateOfBirth *time.Time `json:"dateOfBirth,omitempty"` - DccQuote *ForexQuote `json:"dccQuote,omitempty"` - DeliveryAddress *Address `json:"deliveryAddress,omitempty"` + DateOfBirth *time.Time `json:"dateOfBirth,omitempty"` + DccQuote *ForexQuote `json:"dccQuote,omitempty"` + DeliveryAddress *Address `json:"deliveryAddress,omitempty"` // The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 DeliveryDate *time.Time `json:"deliveryDate,omitempty"` // A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). @@ -37,7 +37,7 @@ type PaymentRequest3d struct { // Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. EnableRealTimeUpdate bool `json:"enableRealTimeUpdate,omitempty"` // An integer value that is added to the normal fraud score. The value can be either positive or negative. - FraudOffset int32 `json:"fraudOffset,omitempty"` + FraudOffset int32 `json:"fraudOffset,omitempty"` Installments *Installments `json:"installments,omitempty"` // The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. Mcc string `json:"mcc,omitempty"` @@ -46,16 +46,16 @@ type PaymentRequest3d struct { // The merchant account identifier, with which you want to process the transaction. MerchantAccount string `json:"merchantAccount"` // This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. - MerchantOrderReference string `json:"merchantOrderReference,omitempty"` - MerchantRiskIndicator *MerchantRiskIndicator `json:"merchantRiskIndicator,omitempty"` + MerchantOrderReference string `json:"merchantOrderReference,omitempty"` + MerchantRiskIndicator *MerchantRiskIndicator `json:"merchantRiskIndicator,omitempty"` // Metadata consists of entries, each of which includes a key and a value. Limitations: Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". - Metadata *map[string]interface{} `json:"metadata,omitempty"` + Metadata map[string]string `json:"metadata,omitempty"` // When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. OrderReference string `json:"orderReference,omitempty"` // Payment authorisation response returned by the card issuer. The `paResponse` field holds the PaRes value received from the card issuer. - PaResponse string `json:"paResponse"` - Recurring *Recurring `json:"recurring,omitempty"` - // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – Card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – A transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + PaResponse string `json:"paResponse"` + Recurring *Recurring `json:"recurring,omitempty"` + // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. RecurringProcessingModel string `json:"recurringProcessingModel,omitempty"` // The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. Reference string `json:"reference,omitempty"` @@ -73,19 +73,19 @@ type PaymentRequest3d struct { ShopperInteraction string `json:"shopperInteraction,omitempty"` // The combination of a language code and a country code to specify the language to be used in the payment. ShopperLocale string `json:"shopperLocale,omitempty"` - ShopperName *Name `json:"shopperName,omitempty"` - // The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments. + ShopperName *Name `json:"shopperName,omitempty"` + // Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. ShopperReference string `json:"shopperReference,omitempty"` - // The text to appear on the shopper's bank statement. + // The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. ShopperStatement string `json:"shopperStatement,omitempty"` // The shopper's social security number. SocialSecurityNumber string `json:"socialSecurityNumber,omitempty"` - // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). + // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). Splits *[]Split `json:"splits,omitempty"` // The physical store, for which this payment is processed. Store string `json:"store,omitempty"` // The shopper's telephone number. - TelephoneNumber string `json:"telephoneNumber,omitempty"` + TelephoneNumber string `json:"telephoneNumber,omitempty"` ThreeDS2RequestData *ThreeDS2RequestData `json:"threeDS2RequestData,omitempty"` // If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. ThreeDSAuthenticationOnly bool `json:"threeDSAuthenticationOnly,omitempty"` diff --git a/src/payments/model_payment_request3ds2.go b/src/payments/model_payment_request3ds2.go index e49bbe992..7cf311515 100644 --- a/src/payments/model_payment_request3ds2.go +++ b/src/payments/model_payment_request3ds2.go @@ -1,9 +1,9 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,20 +16,20 @@ import ( // PaymentRequest3ds2 struct for PaymentRequest3ds2 type PaymentRequest3ds2 struct { - AccountInfo *AccountInfo `json:"accountInfo,omitempty"` - AdditionalAmount *Amount `json:"additionalAmount,omitempty"` + AccountInfo *AccountInfo `json:"accountInfo,omitempty"` + AdditionalAmount *Amount `json:"additionalAmount,omitempty"` // This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. - AdditionalData interface{} `json:"additionalData,omitempty"` - Amount Amount `json:"amount"` + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` + Amount Amount `json:"amount"` ApplicationInfo *ApplicationInfo `json:"applicationInfo,omitempty"` - BillingAddress *Address `json:"billingAddress,omitempty"` - BrowserInfo *BrowserInfo `json:"browserInfo,omitempty"` + BillingAddress *Address `json:"billingAddress,omitempty"` + BrowserInfo *BrowserInfo `json:"browserInfo,omitempty"` // The delay between the authorisation and scheduled auto-capture, specified in hours. CaptureDelayHours int32 `json:"captureDelayHours,omitempty"` // The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD - DateOfBirth *time.Time `json:"dateOfBirth,omitempty"` - DccQuote *ForexQuote `json:"dccQuote,omitempty"` - DeliveryAddress *Address `json:"deliveryAddress,omitempty"` + DateOfBirth *time.Time `json:"dateOfBirth,omitempty"` + DccQuote *ForexQuote `json:"dccQuote,omitempty"` + DeliveryAddress *Address `json:"deliveryAddress,omitempty"` // The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 DeliveryDate *time.Time `json:"deliveryDate,omitempty"` // A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). @@ -37,21 +37,21 @@ type PaymentRequest3ds2 struct { // Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings. EnableRealTimeUpdate bool `json:"enableRealTimeUpdate,omitempty"` // An integer value that is added to the normal fraud score. The value can be either positive or negative. - FraudOffset int32 `json:"fraudOffset,omitempty"` + FraudOffset int32 `json:"fraudOffset,omitempty"` Installments *Installments `json:"installments,omitempty"` // The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. Mcc string `json:"mcc,omitempty"` // The merchant account identifier, with which you want to process the transaction. MerchantAccount string `json:"merchantAccount"` // This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. - MerchantOrderReference string `json:"merchantOrderReference,omitempty"` - MerchantRiskIndicator *MerchantRiskIndicator `json:"merchantRiskIndicator,omitempty"` + MerchantOrderReference string `json:"merchantOrderReference,omitempty"` + MerchantRiskIndicator *MerchantRiskIndicator `json:"merchantRiskIndicator,omitempty"` // Metadata consists of entries, each of which includes a key and a value. Limitations: Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". - Metadata *map[string]interface{} `json:"metadata,omitempty"` + Metadata map[string]string `json:"metadata,omitempty"` // When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. - OrderReference string `json:"orderReference,omitempty"` - Recurring *Recurring `json:"recurring,omitempty"` - // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – Card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – A transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + OrderReference string `json:"orderReference,omitempty"` + Recurring *Recurring `json:"recurring,omitempty"` + // Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. RecurringProcessingModel string `json:"recurringProcessingModel,omitempty"` // The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. Reference string `json:"reference"` @@ -69,21 +69,21 @@ type PaymentRequest3ds2 struct { ShopperInteraction string `json:"shopperInteraction,omitempty"` // The combination of a language code and a country code to specify the language to be used in the payment. ShopperLocale string `json:"shopperLocale,omitempty"` - ShopperName *Name `json:"shopperName,omitempty"` - // The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments. + ShopperName *Name `json:"shopperName,omitempty"` + // Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters. > This field is required for recurring payments. ShopperReference string `json:"shopperReference,omitempty"` - // The text to appear on the shopper's bank statement. + // The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new). We recommend sending a maximum of 25 characters, otherwise banks might truncate the string. ShopperStatement string `json:"shopperStatement,omitempty"` // The shopper's social security number. SocialSecurityNumber string `json:"socialSecurityNumber,omitempty"` - // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/marketpay/processing-payments#providing-split-information). + // Information on how the payment should be split between accounts when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information). Splits *[]Split `json:"splits,omitempty"` // The physical store, for which this payment is processed. Store string `json:"store,omitempty"` // The shopper's telephone number. - TelephoneNumber string `json:"telephoneNumber,omitempty"` + TelephoneNumber string `json:"telephoneNumber,omitempty"` ThreeDS2RequestData *ThreeDS2RequestData `json:"threeDS2RequestData,omitempty"` - ThreeDS2Result *ThreeDS2Result `json:"threeDS2Result,omitempty"` + ThreeDS2Result *ThreeDS2Result `json:"threeDS2Result,omitempty"` // The ThreeDS2Token that was returned in the /authorise call. ThreeDS2Token string `json:"threeDS2Token,omitempty"` // If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. diff --git a/src/payments/model_payment_result.go b/src/payments/model_payment_result.go index 8f4c8d0e2..c8800a56a 100644 --- a/src/payments/model_payment_result.go +++ b/src/payments/model_payment_result.go @@ -1,21 +1,21 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments -import "github.com/adyen/adyen-go-api-library/v3/src/common" +import "github.com/adyen/adyen-go-api-library/v4/src/common" // PaymentResult struct for PaymentResult type PaymentResult struct { // This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**. - AdditionalData interface{} `json:"additionalData,omitempty"` + AdditionalData *map[string]interface{} `json:"additionalData,omitempty"` // Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. AuthCode string `json:"authCode,omitempty"` DccAmount *Amount `json:"dccAmount,omitempty"` @@ -30,8 +30,8 @@ type PaymentResult struct { PaRequest string `json:"paRequest,omitempty"` // Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > `pspReference` is returned only for non-redirect payment methods. PspReference string `json:"pspReference,omitempty"` - // If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + // If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). RefusalReason string `json:"refusalReason,omitempty"` - // The result of the payment. Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. For more information, refer to [Result codes](https://docs.adyen.com/checkout/payment-result-codes). * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + // The result of the payment. For more information, see [Result codes](https://docs.adyen.com/checkout/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. ResultCode common.ResultCode `json:"resultCode,omitempty"` } diff --git a/src/payments/model_recurring.go b/src/payments/model_recurring.go index a678169bb..1732535a0 100644 --- a/src/payments/model_recurring.go +++ b/src/payments/model_recurring.go @@ -1,19 +1,17 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - import ( "time" ) - // Recurring struct for Recurring type Recurring struct { // The type of recurring contract to be used. Possible values: * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/checkout/online-payouts). diff --git a/src/payments/model_response_additional_data3_d_secure.go b/src/payments/model_response_additional_data3_d_secure.go new file mode 100644 index 000000000..fc56401b7 --- /dev/null +++ b/src/payments/model_response_additional_data3_d_secure.go @@ -0,0 +1,16 @@ +/* + * Adyen Payment API + * + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` + * + * API version: 64 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package payments +// ResponseAdditionalData3DSecure struct for ResponseAdditionalData3DSecure +type ResponseAdditionalData3DSecure struct { + // Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** + ScaExemptionRequested string `json:"scaExemptionRequested,omitempty"` +} diff --git a/src/payments/model_response_additional_data_billing_address.go b/src/payments/model_response_additional_data_billing_address.go index daae0c59c..b2f9de0a7 100644 --- a/src/payments/model_response_additional_data_billing_address.go +++ b/src/payments/model_response_additional_data_billing_address.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ResponseAdditionalDataBillingAddress struct for ResponseAdditionalDataBillingAddress type ResponseAdditionalDataBillingAddress struct { // The billing address city passed in the payment request. diff --git a/src/payments/model_response_additional_data_card.go b/src/payments/model_response_additional_data_card.go index cd5060775..87be30155 100644 --- a/src/payments/model_response_additional_data_card.go +++ b/src/payments/model_response_additional_data_card.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ResponseAdditionalDataCard struct for ResponseAdditionalDataCard type ResponseAdditionalDataCard struct { // The Bank Identification Number of a credit card, which is the first six digits of a card number. Example: 521234 @@ -24,6 +23,6 @@ type ResponseAdditionalDataCard struct { CardIssuingCurrency string `json:"cardIssuingCurrency,omitempty"` // The card payment method used for the transaction. Example: amex CardPaymentMethod string `json:"cardPaymentMethod,omitempty"` - // The last four digits of a card number. > Returned only in case of a card payment. + // The last four digits of a card number. > Returned only in case of a card payment. CardSummary string `json:"cardSummary,omitempty"` } diff --git a/src/payments/model_response_additional_data_common.go b/src/payments/model_response_additional_data_common.go index 2b6968a8e..cb6b02f7a 100644 --- a/src/payments/model_response_additional_data_common.go +++ b/src/payments/model_response_additional_data_common.go @@ -1,18 +1,17 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ResponseAdditionalDataCommon struct for ResponseAdditionalDataCommon type ResponseAdditionalDataCommon struct { - // The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions. + // The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions. AcquirerAccountCode string `json:"acquirerAccountCode,omitempty"` // The name of the acquirer processing the payment request. Example: TestPmmAcquirer AcquirerCode string `json:"acquirerCode,omitempty"` @@ -32,13 +31,13 @@ type ResponseAdditionalDataCommon struct { AvsResult string `json:"avsResult,omitempty"` // Raw AVS result received from the acquirer, where available. Example: D AvsResultRaw string `json:"avsResultRaw,omitempty"` - // BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions. + // BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions. Bic string `json:"bic,omitempty"` // Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction. DsTransID string `json:"dsTransID,omitempty"` // The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02 Eci string `json:"eci,omitempty"` - // The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment. + // The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment. ExpiryDate string `json:"expiryDate,omitempty"` // The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR ExtraCostsCurrency string `json:"extraCostsCurrency,omitempty"` @@ -46,15 +45,15 @@ type ResponseAdditionalDataCommon struct { ExtraCostsValue string `json:"extraCostsValue,omitempty"` // The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair. FraudCheckItemNrFraudCheckname string `json:"fraudCheck-[itemNr]-[FraudCheckname],omitempty"` - // Information regarding the funding type of the card. The possible return values are: * CHARGE * CREDIT * DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE * DEFFERED_DEBIT > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. + // Information regarding the funding type of the card. The possible return values are: * CHARGE * CREDIT * DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE * DEFFERED_DEBIT > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. FundingSource string `json:"fundingSource,omitempty"` // Indicates availability of funds. Visa: * \"I\" (fast funds are supported) * \"N\" (otherwise) Mastercard: * \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) * \"N\" (otherwise) > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\". FundsAvailability string `json:"fundsAvailability,omitempty"` - // Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\". Possible values: * 3D Secure Mandated * Closed Account * ContAuth Not Supported * CVC Mandated * Ecommerce Not Allowed * Crossborder Not Supported * Card Updated * Low Authrate Bin * Non-reloadable prepaid card + // Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\". Possible values: * 3D Secure Mandated * Closed Account * ContAuth Not Supported * CVC Mandated * Ecommerce Not Allowed * Crossborder Not Supported * Card Updated * Low Authrate Bin * Non-reloadable prepaid card InferredRefusalReason string `json:"inferredRefusalReason,omitempty"` // The issuing country of the card based on the BIN list that Adyen maintains. Example: JP IssuerCountry string `json:"issuerCountry,omitempty"` - // The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field. + // The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field. McBankNetReferenceNumber string `json:"mcBankNetReferenceNumber,omitempty"` // Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID. NetworkTxReference string `json:"networkTxReference,omitempty"` @@ -64,9 +63,9 @@ type ResponseAdditionalDataCommon struct { PaymentAccountReference string `json:"paymentAccountReference,omitempty"` // The Adyen sub-variant of the payment method used for the payment request. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). Example: mcpro PaymentMethodVariant string `json:"paymentMethodVariant,omitempty"` - // Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown) + // Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown) PayoutEligible string `json:"payoutEligible,omitempty"` - // The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder + // The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder RealtimeAccountUpdaterStatus string `json:"realtimeAccountUpdaterStatus,omitempty"` // Message to be displayed on the terminal. ReceiptFreeText string `json:"receiptFreeText,omitempty"` @@ -94,7 +93,7 @@ type ResponseAdditionalDataCommon struct { ThreeDOfferedResponse string `json:"threeDOfferedResponse,omitempty"` // The 3D Secure 2 version. ThreeDSVersion string `json:"threeDSVersion,omitempty"` - // The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field. + // The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field. VisaTransactionId string `json:"visaTransactionId,omitempty"` // The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. Example: ODgxNDc2MDg2MDExODk5MAAAAAA= Xid string `json:"xid,omitempty"` diff --git a/src/payments/model_response_additional_data_delivery_address.go b/src/payments/model_response_additional_data_delivery_address.go index 3ebeba9ae..8e13c3a58 100644 --- a/src/payments/model_response_additional_data_delivery_address.go +++ b/src/payments/model_response_additional_data_delivery_address.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ResponseAdditionalDataDeliveryAddress struct for ResponseAdditionalDataDeliveryAddress type ResponseAdditionalDataDeliveryAddress struct { // The delivery address city passed in the payment request. diff --git a/src/payments/model_response_additional_data_installments.go b/src/payments/model_response_additional_data_installments.go index fc96e5765..789eaf809 100644 --- a/src/payments/model_response_additional_data_installments.go +++ b/src/payments/model_response_additional_data_installments.go @@ -1,39 +1,38 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ResponseAdditionalDataInstallments struct for ResponseAdditionalDataInstallments type ResponseAdditionalDataInstallments struct { - // The number of installments that the payment amount should be charged with. Example: 5 > Only relevant for card payments in countries that support installments. - InstallmentsValue string `json:"installments.value,omitempty"` // Type of installment. The value of `installmentType` should be **IssuerFinanced**. InstallmentPaymentDataInstallmentType string `json:"installmentPaymentData.installmentType,omitempty"` - // Possible values: * PayInInstallmentsOnly * PayInFullOnly * PayInFullOrInstallments - InstallmentPaymentDataPaymentOptions string `json:"installmentPaymentData.paymentOptions,omitempty"` - // Total number of installments possible for this payment. - InstallmentPaymentDataOptionItemNrNumberOfInstallments string `json:"installmentPaymentData.option[itemNr].numberOfInstallments,omitempty"` - // Interest rate for the installment period. - InstallmentPaymentDataOptionItemNrInterestRate string `json:"installmentPaymentData.option[itemNr].interestRate,omitempty"` - // Installment fee amount in minor units. - InstallmentPaymentDataOptionItemNrInstallmentFee string `json:"installmentPaymentData.option[itemNr].installmentFee,omitempty"` // Annual interest rate. InstallmentPaymentDataOptionItemNrAnnualPercentageRate string `json:"installmentPaymentData.option[itemNr].annualPercentageRate,omitempty"` // First Installment Amount in minor units. InstallmentPaymentDataOptionItemNrFirstInstallmentAmount string `json:"installmentPaymentData.option[itemNr].firstInstallmentAmount,omitempty"` - // Subsequent Installment Amount in minor units. - InstallmentPaymentDataOptionItemNrSubsequentInstallmentAmount string `json:"installmentPaymentData.option[itemNr].subsequentInstallmentAmount,omitempty"` - // Minimum number of installments possible for this payment. - InstallmentPaymentDataOptionItemNrMinimumNumberOfInstallments string `json:"installmentPaymentData.option[itemNr].minimumNumberOfInstallments,omitempty"` + // Installment fee amount in minor units. + InstallmentPaymentDataOptionItemNrInstallmentFee string `json:"installmentPaymentData.option[itemNr].installmentFee,omitempty"` + // Interest rate for the installment period. + InstallmentPaymentDataOptionItemNrInterestRate string `json:"installmentPaymentData.option[itemNr].interestRate,omitempty"` // Maximum number of installments possible for this payment. InstallmentPaymentDataOptionItemNrMaximumNumberOfInstallments string `json:"installmentPaymentData.option[itemNr].maximumNumberOfInstallments,omitempty"` + // Minimum number of installments possible for this payment. + InstallmentPaymentDataOptionItemNrMinimumNumberOfInstallments string `json:"installmentPaymentData.option[itemNr].minimumNumberOfInstallments,omitempty"` + // Total number of installments possible for this payment. + InstallmentPaymentDataOptionItemNrNumberOfInstallments string `json:"installmentPaymentData.option[itemNr].numberOfInstallments,omitempty"` + // Subsequent Installment Amount in minor units. + InstallmentPaymentDataOptionItemNrSubsequentInstallmentAmount string `json:"installmentPaymentData.option[itemNr].subsequentInstallmentAmount,omitempty"` // Total amount in minor units. InstallmentPaymentDataOptionItemNrTotalAmountDue string `json:"installmentPaymentData.option[itemNr].totalAmountDue,omitempty"` + // Possible values: * PayInInstallmentsOnly * PayInFullOnly * PayInFullOrInstallments + InstallmentPaymentDataPaymentOptions string `json:"installmentPaymentData.paymentOptions,omitempty"` + // The number of installments that the payment amount should be charged with. Example: 5 > Only relevant for card payments in countries that support installments. + InstallmentsValue string `json:"installments.value,omitempty"` } diff --git a/src/payments/model_response_additional_data_network_tokens.go b/src/payments/model_response_additional_data_network_tokens.go index 314e6ca39..01c4a7957 100644 --- a/src/payments/model_response_additional_data_network_tokens.go +++ b/src/payments/model_response_additional_data_network_tokens.go @@ -1,21 +1,20 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ResponseAdditionalDataNetworkTokens struct for ResponseAdditionalDataNetworkTokens type ResponseAdditionalDataNetworkTokens struct { // Indicates whether a network token is available for the specified card. NetworkTokenAvailable string `json:"networkToken.available,omitempty"` // The Bank Identification Number of a tokenized card, which is the first six digits of a card number. NetworkTokenBin string `json:"networkToken.bin,omitempty"` - // The last four digits of a card number. + // The last four digits of a network token. NetworkTokenTokenSummary string `json:"networkToken.tokenSummary,omitempty"` } diff --git a/src/payments/model_response_additional_data_opi.go b/src/payments/model_response_additional_data_opi.go new file mode 100644 index 000000000..46ad9130f --- /dev/null +++ b/src/payments/model_response_additional_data_opi.go @@ -0,0 +1,16 @@ +/* + * Adyen Payment API + * + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` + * + * API version: 64 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package payments +// ResponseAdditionalDataOpi struct for ResponseAdditionalDataOpi +type ResponseAdditionalDataOpi struct { + // Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + OpiTransToken string `json:"opi.transToken,omitempty"` +} diff --git a/src/payments/model_response_additional_data_pay_pal.go b/src/payments/model_response_additional_data_pay_pal.go index e62eccd41..1df525573 100644 --- a/src/payments/model_response_additional_data_pay_pal.go +++ b/src/payments/model_response_additional_data_pay_pal.go @@ -1,25 +1,24 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ResponseAdditionalDataPayPal struct for ResponseAdditionalDataPayPal type ResponseAdditionalDataPayPal struct { - // The status of the buyer's PayPal account. Example: unverified - PaypalPayerStatus string `json:"paypalPayerStatus,omitempty"` - // The buyer's country of residence. Example: NL - PaypalPayerResidenceCountry string `json:"paypalPayerResidenceCountry,omitempty"` - // The buyer's PayPal ID. Example: LF5HCWWBRV2KL - PaypalPayerId string `json:"paypalPayerId,omitempty"` // The buyer's PayPal account email address. Example: paypaltest@adyen.com PaypalEmail string `json:"paypalEmail,omitempty"` + // The buyer's PayPal ID. Example: LF5HCWWBRV2KL + PaypalPayerId string `json:"paypalPayerId,omitempty"` + // The buyer's country of residence. Example: NL + PaypalPayerResidenceCountry string `json:"paypalPayerResidenceCountry,omitempty"` + // The status of the buyer's PayPal account. Example: unverified + PaypalPayerStatus string `json:"paypalPayerStatus,omitempty"` // The eligibility for PayPal Seller Protection for this payment. Example: Ineligible PaypalProtectionEligibility string `json:"paypalProtectionEligibility,omitempty"` } diff --git a/src/payments/model_response_additional_data_sepa.go b/src/payments/model_response_additional_data_sepa.go index 0f99cca78..4ec9cd104 100644 --- a/src/payments/model_response_additional_data_sepa.go +++ b/src/payments/model_response_additional_data_sepa.go @@ -1,21 +1,20 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ResponseAdditionalDataSepa struct for ResponseAdditionalDataSepa type ResponseAdditionalDataSepa struct { // The transaction signature date. Format: yyyy-MM-dd SepadirectdebitDateOfSignature string `json:"sepadirectdebit.dateOfSignature,omitempty"` - // Its value corresponds to the pspReference value of the transaction. + // Its value corresponds to the pspReference value of the transaction. SepadirectdebitMandateId string `json:"sepadirectdebit.mandateId,omitempty"` - // This field can take one of the following values: * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. * First: (FRST) Initial/first collection in a series of direct debit instructions. * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. * Final: (FNAL) Last/final collection in a series of direct debit instructions. Example: OOFF + // This field can take one of the following values: * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. * First: (FRST) Initial/first collection in a series of direct debit instructions. * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. * Final: (FNAL) Last/final collection in a series of direct debit instructions. Example: OOFF SepadirectdebitSequenceType string `json:"sepadirectdebit.sequenceType,omitempty"` } diff --git a/src/payments/model_sdk_ephem_pub_key.go b/src/payments/model_sdk_ephem_pub_key.go index fc16f1f56..e6aee309d 100644 --- a/src/payments/model_sdk_ephem_pub_key.go +++ b/src/payments/model_sdk_ephem_pub_key.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // SDKEphemPubKey struct for SDKEphemPubKey type SDKEphemPubKey struct { // The `crv` value as received from the 3D Secure 2 SDK. diff --git a/src/payments/model_shopper_interaction_device.go b/src/payments/model_shopper_interaction_device.go index c2f09ee8b..dbff9f8f9 100644 --- a/src/payments/model_shopper_interaction_device.go +++ b/src/payments/model_shopper_interaction_device.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ShopperInteractionDevice struct for ShopperInteractionDevice type ShopperInteractionDevice struct { // Locale on the shopper interaction device. diff --git a/src/payments/model_split.go b/src/payments/model_split.go index aa4347729..4a5c7d260 100644 --- a/src/payments/model_split.go +++ b/src/payments/model_split.go @@ -1,20 +1,19 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // Split struct for Split type Split struct { // The account to which this split applies. >Required if the type is `MarketPlace`. - Account string `json:"account,omitempty"` - Amount SplitAmount `json:"amount"` + Account string `json:"account,omitempty"` + Amount SplitAmount `json:"amount"` // A description of this split. Description string `json:"description,omitempty"` // The reference of this split. Used to link other operations (e.g. captures and refunds) to this split. >Required if the type is `MarketPlace`. diff --git a/src/payments/model_split_amount.go b/src/payments/model_split_amount.go index 800cb6a4b..9ade78335 100644 --- a/src/payments/model_split_amount.go +++ b/src/payments/model_split_amount.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // SplitAmount struct for SplitAmount type SplitAmount struct { // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). If this value is not provided, the currency in which the payment is made will be used. diff --git a/src/payments/model_three_d_secure_data.go b/src/payments/model_three_d_secure_data.go index 1ffdeeccf..842fade6e 100644 --- a/src/payments/model_three_d_secure_data.go +++ b/src/payments/model_three_d_secure_data.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ThreeDSecureData struct for ThreeDSecureData type ThreeDSecureData struct { // In 3D Secure 1, the authentication response if the shopper was redirected. In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter. @@ -18,7 +17,7 @@ type ThreeDSecureData struct { Cavv string `json:"cavv,omitempty"` // The CAVV algorithm used. Include this only for 3D Secure 1. CavvAlgorithm string `json:"cavvAlgorithm,omitempty"` - // In 3D Secure 1, this is the enrollment response from the 3D directory server. In 3D Secure 2, this is the `transStatus` from the `ARes`. + // In 3D Secure 1, this is the enrollment response from the 3D directory server. In 3D Secure 2, this is the `transStatus` from the `ARes`. DirectoryResponse string `json:"directoryResponse,omitempty"` // Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. DsTransID string `json:"dsTransID,omitempty"` diff --git a/src/payments/model_three_ds1_result.go b/src/payments/model_three_ds1_result.go index 80d6a3e47..8dde9f9cf 100644 --- a/src/payments/model_three_ds1_result.go +++ b/src/payments/model_three_ds1_result.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ThreeDS1Result struct for ThreeDS1Result type ThreeDS1Result struct { // The cardholder authentication value (base64 encoded). diff --git a/src/payments/model_three_ds2_request_data.go b/src/payments/model_three_ds2_request_data.go index 151b15ebc..1b69291f5 100644 --- a/src/payments/model_three_ds2_request_data.go +++ b/src/payments/model_three_ds2_request_data.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ThreeDS2RequestData struct for ThreeDS2RequestData type ThreeDS2RequestData struct { // Required for [authentication-only integration](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. @@ -18,10 +17,10 @@ type ThreeDS2RequestData struct { AcquirerMerchantID string `json:"acquirerMerchantID,omitempty"` // If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. AuthenticationOnly bool `json:"authenticationOnly,omitempty"` - // Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate` + // Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate` ChallengeIndicator string `json:"challengeIndicator,omitempty"` // The environment of the shopper. Allowed values: * `app` * `browser` - DeviceChannel string `json:"deviceChannel"` + DeviceChannel string `json:"deviceChannel"` DeviceRenderOptions *DeviceRenderOptions `json:"deviceRenderOptions,omitempty"` // Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/checkout/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. Mcc string `json:"mcc,omitempty"` @@ -34,7 +33,7 @@ type ThreeDS2RequestData struct { // The `sdkAppID` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. SdkAppID string `json:"sdkAppID,omitempty"` // The `sdkEncData` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. - SdkEncData string `json:"sdkEncData,omitempty"` + SdkEncData string `json:"sdkEncData,omitempty"` SdkEphemPubKey *SDKEphemPubKey `json:"sdkEphemPubKey,omitempty"` // The maximum amount of time in minutes for the 3D Secure 2 authentication process. Optional and only for `deviceChannel` set to **app**. Defaults to **60** minutes. SdkMaxTimeout int32 `json:"sdkMaxTimeout,omitempty"` diff --git a/src/payments/model_three_ds2_result.go b/src/payments/model_three_ds2_result.go index c17d5c31f..452bfa4a4 100644 --- a/src/payments/model_three_ds2_result.go +++ b/src/payments/model_three_ds2_result.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ThreeDS2Result struct for ThreeDS2Result type ThreeDS2Result struct { // The `authenticationValue` value as defined in the 3D Secure 2 specification. diff --git a/src/payments/model_three_ds2_result_request.go b/src/payments/model_three_ds2_result_request.go index 79dad4401..6e8ed9d7b 100644 --- a/src/payments/model_three_ds2_result_request.go +++ b/src/payments/model_three_ds2_result_request.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ThreeDS2ResultRequest struct for ThreeDS2ResultRequest type ThreeDS2ResultRequest struct { // The merchant account identifier, with which you want to process the transaction. diff --git a/src/payments/model_three_ds2_result_response.go b/src/payments/model_three_ds2_result_response.go index 0f52e2bfa..fd979abc0 100644 --- a/src/payments/model_three_ds2_result_response.go +++ b/src/payments/model_three_ds2_result_response.go @@ -1,15 +1,14 @@ /* * Adyen Payment API * - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise ``` + * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/user-management/how-to-get-the-web-service-ws-user-password). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@Company.YourCompany\":\"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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Payments 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise ``` * - * API version: 52 + * API version: 64 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ package payments - // ThreeDS2ResultResponse struct for ThreeDS2ResultResponse type ThreeDS2ResultResponse struct { ThreeDS2Result *ThreeDS2Result `json:"threeDS2Result,omitempty"` diff --git a/src/payouts/api_default.go b/src/payouts/api_default.go index 3519169a5..8efe12014 100644 --- a/src/payouts/api_default.go +++ b/src/payouts/api_default.go @@ -14,7 +14,7 @@ import ( _context "context" _nethttp "net/http" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // Payouts Payouts service diff --git a/src/payouts/model_payout_response.go b/src/payouts/model_payout_response.go index 8c9bcbc8a..74348c766 100644 --- a/src/payouts/model_payout_response.go +++ b/src/payouts/model_payout_response.go @@ -10,7 +10,7 @@ package payouts -import "github.com/adyen/adyen-go-api-library/v3/src/common" +import "github.com/adyen/adyen-go-api-library/v4/src/common" // PayoutResponse struct for PayoutResponse type PayoutResponse struct { diff --git a/src/platformsaccount/.openapi-generator/VERSION b/src/platformsaccount/.openapi-generator/VERSION index ecedc98d1..b5d898602 100644 --- a/src/platformsaccount/.openapi-generator/VERSION +++ b/src/platformsaccount/.openapi-generator/VERSION @@ -1 +1 @@ -4.3.1 \ No newline at end of file +4.3.1-SNAPSHOT \ No newline at end of file diff --git a/src/platformsaccount/README.md b/src/platformsaccount/README.md index adf5274d3..3bcc2d5db 100644 --- a/src/platformsaccount/README.md +++ b/src/platformsaccount/README.md @@ -2,7 +2,7 @@ The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. -For more information, refer to our [documentation](https://docs.adyen.com/marketpay). +For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: @@ -19,13 +19,13 @@ The Account API supports versioning of its endpoints through a version suffix in For example: ``` -https://cal-test.adyen.com/cal/services/Account/v5/createAccountHolder +https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 5 +- API version: 6 - Package version: 1.0.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit [https://support.adyen.com/](https://support.adyen.com/) diff --git a/src/platformsaccount/api/openapi.yaml b/src/platformsaccount/api/openapi.yaml index 1affff5ba..7becd9bc6 100644 --- a/src/platformsaccount/api/openapi.yaml +++ b/src/platformsaccount/api/openapi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.0.3 info: contact: email: support@adyen.com @@ -7,7 +7,7 @@ info: description: |- The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. - For more information, refer to our [documentation](https://docs.adyen.com/marketpay). + For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: @@ -24,18 +24,19 @@ info: For example: ``` - https://cal-test.adyen.com/cal/services/Account/v5/createAccountHolder + https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` termsOfService: https://www.adyen.com/legal/terms-and-conditions title: 'Adyen for Platforms: Account API' - version: "5" + version: "6" servers: -- url: https://cal-test.adyen.com/cal/services/Account/v5 +- url: https://cal-test.adyen.com/cal/services/Account/v6 paths: /checkAccountHolder: post: description: This endpoint allows to trigger the verification of the account holder earlier than it's required by the currently processed volume. + operationId: post-checkAccountHolder requestBody: content: application/json: @@ -50,14 +51,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Request to perform verification for an account holder. x-groupName: Verification x-sortIndex: 5 @@ -67,6 +68,7 @@ paths: holder. If an account is closed, it may not process transactions or have its funds paid out,and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account. + operationId: post-closeAccount requestBody: content: application/json: @@ -81,14 +83,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Close an existing account under an account holder. x-groupName: Accounts x-sortIndex: 3 @@ -98,6 +100,7 @@ paths: accounts. If an account holder is closed, it may not process transactions or pay out funds, and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account. + operationId: post-closeAccountHolder requestBody: content: application/json: @@ -112,14 +115,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Close an existing account holder. x-groupName: Account holders x-sortIndex: 7 @@ -127,6 +130,7 @@ paths: post: description: This endpoint is used to create an account under an existing account holder. An account holder may have multiple accounts. + operationId: post-createAccount requestBody: content: application/json: @@ -141,14 +145,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Create a new account under an existing account holder. x-groupName: Accounts x-sortIndex: 1 @@ -158,6 +162,7 @@ paths: holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. Depending on the legal entity type, different details are required to be provided in the call to this endpoint. + operationId: post-createAccountHolder requestBody: content: application/json: @@ -172,14 +177,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Create a new account holder. x-groupName: Account holders x-sortIndex: 1 @@ -189,6 +194,7 @@ paths: account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `bankAccountUUIDs` specifying bank accounts to delete. + operationId: post-deleteBankAccounts requestBody: content: application/json: @@ -203,14 +209,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Delete bank accounts of an existing account holder. x-groupName: Verification x-sortIndex: 3 @@ -220,6 +226,7 @@ paths: account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `payoutMethodCodes` specifying payout methods to delete. + operationId: post-deletePayoutMethods requestBody: content: application/json: @@ -234,14 +241,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Delete payout methods of an existing account holder. x-groupName: Verification x-sortIndex: 3 @@ -249,6 +256,7 @@ paths: post: description: This endpoint is used to delete existing shareholders from an account holder. + operationId: post-deleteShareholders requestBody: content: application/json: @@ -263,20 +271,21 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Delete shareholders of an existing account holder. x-groupName: Verification x-sortIndex: 4 /getAccountHolder: post: description: This endpoint is used to retrieve the details of an account holder. + operationId: post-getAccountHolder requestBody: content: application/json: @@ -291,14 +300,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Retrieve the details of an account holder. x-groupName: Account holders x-sortIndex: 2 @@ -307,7 +316,8 @@ paths: description: |- This endpoint is used to retrieve documents previously uploaded for use in the KYC Verification of an account holder. - For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks). + For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). + operationId: post-getUploadedDocuments requestBody: content: application/json: @@ -322,14 +332,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Retrieve the uploaded documents of an existing account holder. x-groupName: Verification x-sortIndex: 2 @@ -339,6 +349,7 @@ paths: an account holder is suspended, it may not process transactions or pay out funds. Any payments made to a suspended account holder will be directed to the merchant's liable account. + operationId: post-suspendAccountHolder requestBody: content: application/json: @@ -353,23 +364,24 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Suspend an existing account holder. x-groupName: Account holders x-sortIndex: 5 /unSuspendAccountHolder: post: - description: This endpoint is used to reinstate an existing account holder, - which has been suspended through the `/suspendAccountHolder` endpoint. An - account holder which has been suspended due to KYC verification issues cannot - be reinstated through this endpoint. + description: |- + This endpoint is used to reinstate an existing account holder that has been suspended either through the `/suspendAccountHolder` endpoint or because a KYC deadline expired. + + However, an account holder that has been suspended by Adyen because of KYC verification issues (indicated by a **FAILED** verification [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)) cannot be reinstated through this endpoint. + operationId: post-unSuspendAccountHolder requestBody: content: application/json: @@ -384,14 +396,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Reinstate a disabled account holder. x-groupName: Account holders x-sortIndex: 6 @@ -399,6 +411,7 @@ paths: post: description: This endpoint is used to update the description or payout schedule of an existing account. + operationId: post-updateAccount requestBody: content: application/json: @@ -413,14 +426,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Update an existing account under an account holder. x-groupName: Accounts x-sortIndex: 2 @@ -439,6 +452,7 @@ paths: Similarly, it can also be used to create new shareholders by providing details of a shareholder without providing a `shareholderCode`. > The updating of the `metadata` field will overwite all of the existing account holder metadata. In order to update an existing metadata key-value pair, all otherkey-value pairs should be provided in order to not delete them. + operationId: post-updateAccountHolder requestBody: content: application/json: @@ -453,23 +467,24 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Update an existing account holder. x-groupName: Account holders x-sortIndex: 3 /updateAccountHolderState: post: description: |- - This endpoint is used to disable or enable the processing or payout state of an account holder. It cannot be used to enable an account holder whose processing or payout state has not been disabled through this endpoint. + This endpoint is used to disable or enable the processing or payout state of an account holder. - For more information about processing and payout states of an account holder, refer to [our documentation](https://docs.adyen.com/marketpay). + For more information about processing and payout states of an account holder, refer to [our documentation](https://docs.adyen.com/platforms). + operationId: post-updateAccountHolderState requestBody: content: application/json: @@ -484,14 +499,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Update the state of an existing account holder. x-groupName: Account holders x-sortIndex: 4 @@ -500,7 +515,8 @@ paths: description: |- This endpoint is used to upload a document for use in the KYC verification of an account holder. - For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks). + For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). + operationId: post-uploadDocument requestBody: content: application/json: @@ -515,14 +531,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Upload a document for an existing account holder. x-groupName: Verification x-sortIndex: 1 @@ -533,17 +549,27 @@ components: accountCode: accountCode metadata: key: metadata + bankAccountUUID: bankAccountUUID beneficiaryAccount: beneficiaryAccount + payoutMethodCode: payoutMethodCode description: description beneficiaryMerchantReference: beneficiaryMerchantReference payoutSchedule: schedule: BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT nextScheduledPayout: 2000-01-23T04:56:07.000+00:00 + payoutSpeed: SAME_DAY status: status properties: accountCode: description: The code of the account. type: string + bankAccountUUID: + description: The bankAccountUUID of the bank account held by the account + holder to couple the account with. Scheduled payouts in currencies matching + the currency of this bank account will be sent to this bank account. Payouts + in different currencies will be sent to a matching bank account of the + account holder. + type: string beneficiaryAccount: description: The beneficiary of the account. type: string @@ -563,8 +589,20 @@ components: The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. type: object + payoutMethodCode: + description: The payout method code held by the account holder to couple + the account with. Scheduled card payouts will be sent using this payout + method code. + type: string payoutSchedule: $ref: '#/components/schemas/PayoutScheduleResponse' + payoutSpeed: + description: 'Speed with which payouts for this account are processed. Permitted + values: `STANDARD`, `SAME_DAY`.' + enum: + - SAME_DAY + - STANDARD + type: string status: description: 'The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`.' @@ -579,7 +617,7 @@ components: description: |- The event. >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. - For more information, refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks). + For more information, refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). enum: - InactivateAccount - RefundNotPaidOutTransfers @@ -694,6 +732,8 @@ components: merchantCategoryCode: merchantCategoryCode fullPhoneNumber: fullPhoneNumber businessDetails: + stockExchange: stockExchange + stockNumber: stockNumber shareholders: - address: country: country @@ -769,6 +809,8 @@ components: registrationNumber: registrationNumber taxId: taxId legalBusinessName: legalBusinessName + stockTicker: stockTicker + bankAggregatorDataReference: bankAggregatorDataReference email: email properties: address: @@ -777,10 +819,14 @@ components: description: |- Each of the bank accounts associated with the account holder. > Each array entry should represent one bank account. - > For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks). + > For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). items: $ref: '#/components/schemas/BankAccountDetail' type: array + bankAggregatorDataReference: + description: The opaque reference value returned by the Adyen API during + bank account login. + type: string businessDetails: $ref: '#/components/schemas/BusinessDetails' email: @@ -811,7 +857,7 @@ components: description: |- Each of the card tokens associated with the account holder. > Each array entry should represent one card token. - > For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks). + > For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). items: $ref: '#/components/schemas/PayoutMethod' type: array @@ -876,11 +922,7 @@ components: description: The reason why the status was assigned to the account holder. type: string required: - - events - - payoutState - - processingState - status - - statusReason AccountPayoutState: example: disableReason: disableReason @@ -924,13 +966,6 @@ components: description: The payout tier that the account holder occupies. format: int32 type: integer - required: - - allowPayout - - disableReason - - disabled - - notAllowedReason - - payoutLimit - - tierNumber AccountProcessingState: example: disableReason: disableReason @@ -957,12 +992,6 @@ components: description: The processing tier that the account holder occupies. format: int32 type: integer - required: - - disableReason - - disabled - - processedFrom - - processedTo - - tierNumber Amount: example: currency: currency @@ -974,10 +1003,7 @@ components: minLength: 3 type: string value: - description: |- - The payable amount that can be charged for the transaction. - - The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). format: int64 type: integer required: @@ -1015,7 +1041,7 @@ components: accountNumber: description: |- The bank account number (without separators). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string accountType: description: |- @@ -1023,7 +1049,7 @@ components: Only applicable to bank accounts held in the USA. The permitted values are: `checking`, `savings`. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string bankAccountName: description: The name of the bank account. @@ -1045,25 +1071,25 @@ components: bankBicSwift: description: |- The bank identifier code. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string bankCity: description: |- The city in which the bank branch is located. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string bankCode: description: |- The bank code of the banking institution with which the bank account is registered. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string bankName: description: |- The name of the banking institution with which the bank account is held. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string branchCode: description: |- @@ -1071,46 +1097,46 @@ components: * United States - Routing number * United Kingdom - Sort code * Germany - Bankleitzahl - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string checkCode: description: |- The check code of the bank account. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string countryCode: description: |- The two-letter country code in which the bank account is registered. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string currencyCode: description: |- The currency in which the bank account deals. >The permitted currency codes are defined in ISO-4217 (e.g. 'EUR'). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string iban: description: |- The international bank account number. >The IBAN standard is defined in ISO-13616. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerCity: description: |- The city of residence of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerCountryCode: description: |- The country code of the country of residence of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerDateOfBirth: description: | @@ -1119,34 +1145,34 @@ components: ownerHouseNumberOrName: description: |- The house name or number of the residence of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerName: description: |- The name of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerNationality: description: |- The country code of the country of nationality of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerPostalCode: description: |- The postal code of the residence of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerState: description: |- The state of residence of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerStreet: description: |- The street name of the residence of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string primaryAccount: description: If set to true, the bank account is a primary account. @@ -1155,17 +1181,19 @@ components: description: |- The tax ID number. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string urlForVerification: description: |- The URL to be used for bank account verification. This may be generated on bank account creation. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string BusinessDetails: example: + stockExchange: stockExchange + stockNumber: stockNumber shareholders: - address: country: country @@ -1241,6 +1269,7 @@ components: registrationNumber: registrationNumber taxId: taxId legalBusinessName: legalBusinessName + stockTicker: stockTicker properties: doingBusinessAs: description: The registered name of the company (if it differs from the @@ -1259,6 +1288,15 @@ components: items: $ref: '#/components/schemas/ShareholderContact' type: array + stockExchange: + description: Market Identifier Code (MIC). + type: string + stockNumber: + description: International Securities Identification Number (ISIN). + type: string + stockTicker: + description: Stock Ticker symbol. + type: string taxId: description: The tax ID of the company. type: string @@ -1327,7 +1365,7 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -1335,7 +1373,6 @@ components: type: string required: - accountHolderStatus - - pspReference CloseAccountRequest: example: accountCode: accountCode @@ -1375,7 +1412,7 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -1392,7 +1429,6 @@ components: - Suspended type: string required: - - pspReference - status CreateAccountHolderRequest: example: @@ -1496,6 +1532,8 @@ components: merchantCategoryCode: merchantCategoryCode fullPhoneNumber: fullPhoneNumber businessDetails: + stockExchange: stockExchange + stockNumber: stockNumber shareholders: - address: country: country @@ -1571,8 +1609,11 @@ components: registrationNumber: registrationNumber taxId: taxId legalBusinessName: legalBusinessName + stockTicker: stockTicker + bankAggregatorDataReference: bankAggregatorDataReference email: email description: description + verificationProfile: verificationProfile processingTier: 0 primaryCurrency: primaryCurrency legalEntity: Business @@ -1590,7 +1631,9 @@ components: **Default Value:** true type: boolean description: - description: A description of the prospective account holder. + description: A description of the prospective account holder, maximum 256 + characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white + spaces, and underscores `_`. type: string legalEntity: description: |- @@ -1612,10 +1655,13 @@ components: with which the prospective account holder primarily deals. type: string processingTier: - description: The starting [processing tier](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks#tiers) + description: The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 type: integer + verificationProfile: + description: The identifier of the profile that applies to this entity. + type: string required: - accountHolderCode - accountHolderDetails @@ -1735,6 +1781,8 @@ components: merchantCategoryCode: merchantCategoryCode fullPhoneNumber: fullPhoneNumber businessDetails: + stockExchange: stockExchange + stockNumber: stockNumber shareholders: - address: country: country @@ -1810,6 +1858,8 @@ components: registrationNumber: registrationNumber taxId: taxId legalBusinessName: legalBusinessName + stockTicker: stockTicker + bankAggregatorDataReference: bankAggregatorDataReference email: email accountHolderStatus: processingState: @@ -1842,6 +1892,7 @@ components: status: Active resultCode: resultCode description: description + verificationProfile: verificationProfile primaryCurrency: primaryCurrency pspReference: pspReference verification: @@ -1863,7 +1914,7 @@ components: - requiredFields type: BANK_ACCOUNT_VERIFICATION status: AWAITING_DATA - cards: + payoutMethods: - checks: - summary: kycCheckCode: 0 @@ -1937,43 +1988,6 @@ components: type: BANK_ACCOUNT_VERIFICATION status: AWAITING_DATA shareholderCode: shareholderCode - bankAccounts: - - bankAccountUUID: bankAccountUUID - checks: - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - bankAccountUUID: bankAccountUUID - checks: - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA legalEntity: Business properties: accountCode: @@ -2009,7 +2023,7 @@ components: with which the prospective account holder primarily deals. type: string pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -2017,27 +2031,41 @@ components: type: string verification: $ref: '#/components/schemas/KYCVerificationResult' + verificationProfile: + description: The identifier of the profile that applies to this entity. + type: string required: - accountHolderCode - accountHolderDetails - accountHolderStatus - legalEntity - - pspReference - verification CreateAccountRequest: example: accountHolderCode: accountHolderCode metadata: key: metadata + bankAccountUUID: bankAccountUUID + payoutMethodCode: payoutMethodCode description: description payoutScheduleReason: payoutScheduleReason payoutSchedule: BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT + payoutSpeed: STANDARD properties: accountHolderCode: description: The code of Account Holder under which to create the account. type: string + bankAccountUUID: + description: The bankAccountUUID of the bank account held by the account + holder to couple the account with. Scheduled payouts in currencies matching + the currency of this bank account will be sent to this bank account. Payouts + in different currencies will be sent to a matching bank account of the + account holder. + type: string description: - description: A description of the account. + description: A description of the account, maximum 256 characters. You can + use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores + `_`. type: string metadata: additionalProperties: @@ -2047,6 +2075,11 @@ components: The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. type: object + payoutMethodCode: + description: The payout method code held by the account holder to couple + the account with. Scheduled card payouts will be sent using this payout + method code. + type: string payoutSchedule: description: |- The payout schedule of the prospective account. @@ -2072,6 +2105,14 @@ components: The reason for the payout schedule choice. >Required if the payoutSchedule is `HOLD`. type: string + payoutSpeed: + default: STANDARD + description: 'Speed with which payouts for this account are processed. Permitted + values: `STANDARD`, `SAME_DAY`.' + enum: + - SAME_DAY + - STANDARD + type: string required: - accountHolderCode CreateAccountResponse: @@ -2080,6 +2121,7 @@ components: accountHolderCode: accountHolderCode metadata: key: metadata + bankAccountUUID: bankAccountUUID invalidFields: - errorDescription: errorDescription errorCode: 0 @@ -2093,12 +2135,14 @@ components: fieldName: accountCode field: field shareholderCode: shareholderCode + payoutMethodCode: payoutMethodCode resultCode: resultCode description: description pspReference: pspReference payoutSchedule: schedule: BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT nextScheduledPayout: 2000-01-23T04:56:07.000+00:00 + payoutSpeed: SAME_DAY status: Active properties: accountCode: @@ -2107,6 +2151,13 @@ components: accountHolderCode: description: The code of the account holder. type: string + bankAccountUUID: + description: The bankAccountUUID of the bank account held by the account + holder to couple the account with. Scheduled payouts in currencies matching + the currency of this bank account will be sent to this bank account. Payouts + in different currencies will be sent to a matching bank account of the + account holder. + type: string description: description: The description of the account. type: string @@ -2120,10 +2171,22 @@ components: additionalProperties: type: string type: object + payoutMethodCode: + description: The payout method code held by the account holder to couple + the account with. Scheduled card payouts will be sent using this payout + method code. + type: string payoutSchedule: $ref: '#/components/schemas/PayoutScheduleResponse' + payoutSpeed: + description: 'Speed with which payouts for this account are processed. Permitted + values: `STANDARD`, `SAME_DAY`.' + enum: + - SAME_DAY + - STANDARD + type: string pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -2142,7 +2205,6 @@ components: required: - accountCode - accountHolderCode - - pspReference - status DeleteBankAccountRequest: example: @@ -2217,7 +2279,7 @@ components: The unique ID of the Bank Account to which the document applies. >Required if the documentType is `BANK_STATEMENT` (i.e., a document is being submitted in order to verify a bank account). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account. type: string description: description: Description of the document. @@ -2232,7 +2294,7 @@ components: * `DRIVING_LICENCE_FRONT` denotes an image containing only the front of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_BACK` must be submitted. * `DRIVING_LICENCE_BACK` denotes an image containing only the back of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_FRONT` must be submitted. - >Please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks) for details on when each document type should be submitted. + >Please refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks) for details on when each document type should be submitted. enum: - BANK_STATEMENT - BSN @@ -2255,7 +2317,7 @@ components: The code of the shareholder, to which the document applies. >Required if the account holder referred to by the `accountHolderCode` has a `legalEntity` of type `Business` and the `documentType` is either `PASSPORT`, `ID_CARD_FRONT`, `ID_CARD_BACK`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK` (i.e. a document is being submitted in order to verify a shareholder). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder. type: string required: - accountHolderCode @@ -2334,6 +2396,7 @@ components: - drivingLicense - email - firstName + - formType - fullPhoneNumber - gender - hopWebserviceUser @@ -2381,6 +2444,9 @@ components: - sourceAccountCode - stateOrProvince - status + - stockExchange + - stockNumber + - stockTicker - store - storeDetail - storeName @@ -2395,6 +2461,7 @@ components: - virtualAccount - visaNumber - webAddress + - year type: string shareholderCode: description: The code of the shareholder that the field belongs to. If empty, @@ -2425,14 +2492,12 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: description: The result code. type: string - required: - - pspReference GetAccountHolderRequest: example: accountCode: accountCode @@ -2455,6 +2520,40 @@ components: GetAccountHolderResponse: example: accountHolderCode: accountHolderCode + accountHolderStatus: + processingState: + disableReason: disableReason + processedTo: + currency: currency + value: 0 + processedFrom: + currency: currency + value: 0 + tierNumber: 1 + disabled: true + statusReason: statusReason + payoutState: + disableReason: disableReason + notAllowedReason: notAllowedReason + allowPayout: true + tierNumber: 6 + disabled: true + payoutLimit: + currency: currency + value: 0 + events: + - reason: reason + executionDate: 2000-01-23T04:56:07.000+00:00 + event: InactivateAccount + - reason: reason + executionDate: 2000-01-23T04:56:07.000+00:00 + event: InactivateAccount + status: Active + resultCode: resultCode + description: description + verificationProfile: verificationProfile + primaryCurrency: primaryCurrency + legalEntity: Business invalidFields: - errorDescription: errorDescription errorCode: 0 @@ -2567,6 +2666,8 @@ components: merchantCategoryCode: merchantCategoryCode fullPhoneNumber: fullPhoneNumber businessDetails: + stockExchange: stockExchange + stockNumber: stockNumber shareholders: - address: country: country @@ -2642,60 +2743,36 @@ components: registrationNumber: registrationNumber taxId: taxId legalBusinessName: legalBusinessName + stockTicker: stockTicker + bankAggregatorDataReference: bankAggregatorDataReference email: email - accountHolderStatus: - processingState: - disableReason: disableReason - processedTo: - currency: currency - value: 0 - processedFrom: - currency: currency - value: 0 - tierNumber: 1 - disabled: true - statusReason: statusReason - payoutState: - disableReason: disableReason - notAllowedReason: notAllowedReason - allowPayout: true - tierNumber: 6 - disabled: true - payoutLimit: - currency: currency - value: 0 - events: - - reason: reason - executionDate: 2000-01-23T04:56:07.000+00:00 - event: InactivateAccount - - reason: reason - executionDate: 2000-01-23T04:56:07.000+00:00 - event: InactivateAccount - status: Active - resultCode: resultCode - description: description accounts: - accountCode: accountCode metadata: key: metadata + bankAccountUUID: bankAccountUUID beneficiaryAccount: beneficiaryAccount + payoutMethodCode: payoutMethodCode description: description beneficiaryMerchantReference: beneficiaryMerchantReference payoutSchedule: schedule: BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT nextScheduledPayout: 2000-01-23T04:56:07.000+00:00 + payoutSpeed: SAME_DAY status: status - accountCode: accountCode metadata: key: metadata + bankAccountUUID: bankAccountUUID beneficiaryAccount: beneficiaryAccount + payoutMethodCode: payoutMethodCode description: description beneficiaryMerchantReference: beneficiaryMerchantReference payoutSchedule: schedule: BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT nextScheduledPayout: 2000-01-23T04:56:07.000+00:00 + payoutSpeed: SAME_DAY status: status - primaryCurrency: primaryCurrency pspReference: pspReference verification: accountHolder: @@ -2716,7 +2793,7 @@ components: - requiredFields type: BANK_ACCOUNT_VERIFICATION status: AWAITING_DATA - cards: + payoutMethods: - checks: - summary: kycCheckCode: 0 @@ -2790,44 +2867,6 @@ components: type: BANK_ACCOUNT_VERIFICATION status: AWAITING_DATA shareholderCode: shareholderCode - bankAccounts: - - bankAccountUUID: bankAccountUUID - checks: - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - bankAccountUUID: bankAccountUUID - checks: - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - legalEntity: Business properties: accountHolderCode: description: The code of the account holder. @@ -2864,7 +2903,7 @@ components: with which the prospective account holder primarily deals. type: string pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -2877,12 +2916,14 @@ components: type: string verification: $ref: '#/components/schemas/KYCVerificationResult' + verificationProfile: + description: The identifier of the profile that applies to this entity. + type: string required: - accountHolderCode - accountHolderDetails - accountHolderStatus - legalEntity - - pspReference - verification GetAccountHolderStatusResponse: example: @@ -2944,7 +2985,7 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -2953,7 +2994,6 @@ components: required: - accountHolderCode - accountHolderStatus - - pspReference GetUploadedDocumentsRequest: example: accountHolderCode: accountHolderCode @@ -3014,14 +3054,12 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: description: The result code. type: string - required: - - pspReference IndividualDetails: example: personalData: @@ -3048,70 +3086,6 @@ components: $ref: '#/components/schemas/ViasName' personalData: $ref: '#/components/schemas/ViasPersonalData' - KYCBankAccountCheckResult: - example: - bankAccountUUID: bankAccountUUID - checks: - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - properties: - bankAccountUUID: - description: The unique ID of the bank account to which the check applies. - type: string - checks: - description: A list of the checks and their statuses. - items: - $ref: '#/components/schemas/KYCCheckStatusData' - type: array - required: - - bankAccountUUID - - checks - KYCCardCheckResult: - example: - checks: - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - payoutMethodCode: payoutMethodCode - properties: - checks: - description: A list of the checks and their statuses. - items: - $ref: '#/components/schemas/KYCCheckStatusData' - type: array - payoutMethodCode: - description: The unique ID of the card to which the check applies. - type: string - required: - - checks - - payoutMethodCode KYCCheckResult: example: checks: @@ -3137,8 +3111,6 @@ components: items: $ref: '#/components/schemas/KYCCheckStatusData' type: array - required: - - checks KYCCheckStatusData: example: summary: @@ -3186,9 +3158,7 @@ components: - PAYOUT_METHOD_VERIFICATION type: string required: - - requiredFields - status - - summary - type KYCCheckSummary: example: @@ -3202,6 +3172,35 @@ components: kycCheckDescription: description: A description of the check. type: string + KYCPayoutMethodCheckResult: + example: + checks: + - summary: + kycCheckCode: 0 + kycCheckDescription: kycCheckDescription + requiredFields: + - requiredFields + - requiredFields + type: BANK_ACCOUNT_VERIFICATION + status: AWAITING_DATA + - summary: + kycCheckCode: 0 + kycCheckDescription: kycCheckDescription + requiredFields: + - requiredFields + - requiredFields + type: BANK_ACCOUNT_VERIFICATION + status: AWAITING_DATA + payoutMethodCode: payoutMethodCode + properties: + checks: + description: A list of the checks and their statuses. + items: + $ref: '#/components/schemas/KYCCheckStatusData' + type: array + payoutMethodCode: + description: The unique ID of the payoput method to which the check applies. + type: string KYCShareholderCheckResult: example: checks: @@ -3231,9 +3230,6 @@ components: shareholderCode: description: The code of the shareholder to which the check applies. type: string - required: - - checks - - shareholderCode KYCVerificationResult: example: accountHolder: @@ -3254,7 +3250,7 @@ components: - requiredFields type: BANK_ACCOUNT_VERIFICATION status: AWAITING_DATA - cards: + payoutMethods: - checks: - summary: kycCheckCode: 0 @@ -3328,66 +3324,19 @@ components: type: BANK_ACCOUNT_VERIFICATION status: AWAITING_DATA shareholderCode: shareholderCode - bankAccounts: - - bankAccountUUID: bankAccountUUID - checks: - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - bankAccountUUID: bankAccountUUID - checks: - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA properties: accountHolder: $ref: '#/components/schemas/KYCCheckResult' - bankAccounts: - description: The result(s) of the checks on the bank account(s). - items: - $ref: '#/components/schemas/KYCBankAccountCheckResult' - type: array - cards: - description: The result(s) of the checks on the card(s). + payoutMethods: + description: The result(s) of the checks on the payout method(s). items: - $ref: '#/components/schemas/KYCCardCheckResult' + $ref: '#/components/schemas/KYCPayoutMethodCheckResult' type: array shareholders: description: The result(s) of the checks on the shareholder(s). items: $ref: '#/components/schemas/KYCShareholderCheckResult' type: array - required: - - accountHolder - - bankAccounts - - cards - - shareholders PayoutMethod: example: merchantAccount: merchantAccount @@ -3512,7 +3461,6 @@ components: - VISA type: string required: - - number - type ShareholderContact: example: @@ -3650,7 +3598,7 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -3658,7 +3606,6 @@ components: type: string required: - accountHolderStatus - - pspReference UnSuspendAccountHolderRequest: example: accountHolderCode: accountHolderCode @@ -3724,7 +3671,7 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -3732,7 +3679,6 @@ components: type: string required: - accountHolderStatus - - pspReference UpdateAccountHolderRequest: example: accountHolderCode: accountHolderCode @@ -3834,6 +3780,8 @@ components: merchantCategoryCode: merchantCategoryCode fullPhoneNumber: fullPhoneNumber businessDetails: + stockExchange: stockExchange + stockNumber: stockNumber shareholders: - address: country: country @@ -3909,8 +3857,11 @@ components: registrationNumber: registrationNumber taxId: taxId legalBusinessName: legalBusinessName + stockTicker: stockTicker + bankAggregatorDataReference: bankAggregatorDataReference email: email description: description + verificationProfile: verificationProfile processingTier: 0 primaryCurrency: primaryCurrency legalEntity: Business @@ -3921,7 +3872,9 @@ components: accountHolderDetails: $ref: '#/components/schemas/AccountHolderDetails' description: - description: The description to which the Account Holder should be updated. + description: A description of the account holder, maximum 256 characters. + You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and + underscores `_`. type: string legalEntity: description: |- @@ -3950,6 +3903,9 @@ components: >Required if accountHolderDetails are not provided. format: int32 type: integer + verificationProfile: + description: The identifier of the profile that applies to this entity. + type: string required: - accountHolderCode UpdateAccountHolderResponse: @@ -4066,6 +4022,8 @@ components: merchantCategoryCode: merchantCategoryCode fullPhoneNumber: fullPhoneNumber businessDetails: + stockExchange: stockExchange + stockNumber: stockNumber shareholders: - address: country: country @@ -4141,6 +4099,8 @@ components: registrationNumber: registrationNumber taxId: taxId legalBusinessName: legalBusinessName + stockTicker: stockTicker + bankAggregatorDataReference: bankAggregatorDataReference email: email accountHolderStatus: processingState: @@ -4173,6 +4133,7 @@ components: status: Active resultCode: resultCode description: description + verificationProfile: verificationProfile primaryCurrency: primaryCurrency pspReference: pspReference verification: @@ -4194,7 +4155,7 @@ components: - requiredFields type: BANK_ACCOUNT_VERIFICATION status: AWAITING_DATA - cards: + payoutMethods: - checks: - summary: kycCheckCode: 0 @@ -4268,43 +4229,6 @@ components: type: BANK_ACCOUNT_VERIFICATION status: AWAITING_DATA shareholderCode: shareholderCode - bankAccounts: - - bankAccountUUID: bankAccountUUID - checks: - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - bankAccountUUID: bankAccountUUID - checks: - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA - - summary: - kycCheckCode: 0 - kycCheckDescription: kycCheckDescription - requiredFields: - - requiredFields - - requiredFields - type: BANK_ACCOUNT_VERIFICATION - status: AWAITING_DATA legalEntity: Business properties: accountHolderCode: @@ -4337,7 +4261,7 @@ components: with which the prospective account holder primarily deals. type: string pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -4345,10 +4269,12 @@ components: type: string verification: $ref: '#/components/schemas/KYCVerificationResult' + verificationProfile: + description: The identifier of the profile that applies to this entity. + type: string required: - accountHolderStatus - legalEntity - - pspReference - verification UpdateAccountHolderStateRequest: example: @@ -4390,17 +4316,29 @@ components: accountCode: accountCode metadata: key: metadata + bankAccountUUID: bankAccountUUID + payoutMethodCode: payoutMethodCode description: description payoutSchedule: reason: reason schedule: BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT action: CLOSE + payoutSpeed: SAME_DAY properties: accountCode: description: The code of the account to update. type: string + bankAccountUUID: + description: The bankAccountUUID of the bank account held by the account + holder to couple the account with. Scheduled payouts in currencies matching + the currency of this bank account will be sent to this bank account. Payouts + in different currencies will be sent to a matching bank account of the + account holder. + type: string description: - description: A description of the account. + description: A description of the account, maximum 256 characters.You can + use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores + `_`. type: string metadata: additionalProperties: @@ -4410,8 +4348,20 @@ components: The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. type: object + payoutMethodCode: + description: The payout method code held by the account holder to couple + the account with. Scheduled card payouts will be sent using this payout + method code. + type: string payoutSchedule: $ref: '#/components/schemas/UpdatePayoutScheduleRequest' + payoutSpeed: + description: 'Speed with which payouts for this account are processed. Permitted + values: `STANDARD`, `SAME_DAY`.' + enum: + - SAME_DAY + - STANDARD + type: string required: - accountCode UpdateAccountResponse: @@ -4419,6 +4369,7 @@ components: accountCode: accountCode metadata: key: metadata + bankAccountUUID: bankAccountUUID invalidFields: - errorDescription: errorDescription errorCode: 0 @@ -4432,16 +4383,25 @@ components: fieldName: accountCode field: field shareholderCode: shareholderCode + payoutMethodCode: payoutMethodCode resultCode: resultCode description: description pspReference: pspReference payoutSchedule: schedule: BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT nextScheduledPayout: 2000-01-23T04:56:07.000+00:00 + payoutSpeed: SAME_DAY properties: accountCode: description: The code of the account. type: string + bankAccountUUID: + description: The bankAccountUUID of the bank account held by the account + holder to couple the account with. Scheduled payouts in currencies matching + the currency of this bank account will be sent to this bank account. Payouts + in different currencies will be sent to a matching bank account of the + account holder. + type: string description: description: The description of the account. type: string @@ -4455,10 +4415,22 @@ components: additionalProperties: type: string type: object + payoutMethodCode: + description: The payout method code held by the account holder to couple + the account with. Scheduled card payouts will be sent using this payout + method code. + type: string payoutSchedule: $ref: '#/components/schemas/PayoutScheduleResponse' + payoutSpeed: + description: 'Speed with which payouts for this account are processed. Permitted + values: `STANDARD`, `SAME_DAY`.' + enum: + - SAME_DAY + - STANDARD + type: string pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -4466,8 +4438,6 @@ components: type: string required: - accountCode - - payoutSchedule - - pspReference UpdatePayoutScheduleRequest: example: reason: reason @@ -4529,7 +4499,7 @@ components: description: |- The content of the document as represented by a Base64-encoded string. - To learn about requirements, see [Bank account check](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks/bank-account-check#requirements) and [Photo ID check](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks/photo-id-check#requirements). + To learn about requirements, see [Bank account check](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks/bank-account-check#requirements) and [Photo ID check](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks/photo-id-check#requirements). format: byte type: string documentDetail: @@ -4674,6 +4644,14 @@ components: required: - phoneCountryCode - phoneNumber + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http x-groups: - Account holders - Accounts diff --git a/src/platformsaccount/api_default.go b/src/platformsaccount/api_default.go index a76e3d6fc..7f08ff193 100644 --- a/src/platformsaccount/api_default.go +++ b/src/platformsaccount/api_default.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,216 +14,216 @@ import ( _context "context" _nethttp "net/http" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // PlatformsAccount PlatformsAccount service type PlatformsAccount common.Service /* -CheckAccountHolderPost Request to perform verification for an account holder. +PostCheckAccountHolder Request to perform verification for an account holder. This endpoint allows to trigger the verification of the account holder earlier than it's required by the currently processed volume. - * @param request PerformVerificationRequest - reference of PerformVerificationRequest). + * @param request PerformVerificationRequest - reference of PerformVerificationRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return GenericResponse */ func (a PlatformsAccount) CheckAccountHolder(req *PerformVerificationRequest, ctxs ..._context.Context) (GenericResponse, *_nethttp.Response, error) { - res := &GenericResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/checkAccountHolder", ctxs...) - return *res, httpRes, err + res := &GenericResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/checkAccountHolder", ctxs...) + return *res, httpRes, err } /* -CloseAccountHolderPost Close an existing account holder. -This endpoint is used to close an existing account holder and its accounts. If an account holder is closed, it may not process transactions or pay out funds, and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account. - * @param request CloseAccountHolderRequest - reference of CloseAccountHolderRequest). - * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return CloseAccountHolderResponse -*/ -func (a PlatformsAccount) CloseAccountHolder(req *CloseAccountHolderRequest, ctxs ..._context.Context) (CloseAccountHolderResponse, *_nethttp.Response, error) { - res := &CloseAccountHolderResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/closeAccountHolder", ctxs...) - return *res, httpRes, err -} - -/* -CloseAccountPost Close an existing account under an account holder. +PostCloseAccount Close an existing account under an account holder. This endpoint is used to close an existing account under an account holder. If an account is closed, it may not process transactions or have its funds paid out,and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account. - * @param request CloseAccountRequest - reference of CloseAccountRequest). + * @param request CloseAccountRequest - reference of CloseAccountRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return CloseAccountResponse */ func (a PlatformsAccount) CloseAccount(req *CloseAccountRequest, ctxs ..._context.Context) (CloseAccountResponse, *_nethttp.Response, error) { - res := &CloseAccountResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/closeAccount", ctxs...) - return *res, httpRes, err + res := &CloseAccountResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/closeAccount", ctxs...) + return *res, httpRes, err } /* -CreateAccountHolderPost Create a new account holder. -This endpoint is used to create an account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. Depending on the legal entity type, different details are required to be provided in the call to this endpoint. - * @param request CreateAccountHolderRequest - reference of CreateAccountHolderRequest). +PostCloseAccountHolder Close an existing account holder. +This endpoint is used to close an existing account holder and its accounts. If an account holder is closed, it may not process transactions or pay out funds, and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account. + * @param request CloseAccountHolderRequest - reference of CloseAccountHolderRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return CreateAccountHolderResponse +@return CloseAccountHolderResponse */ -func (a PlatformsAccount) CreateAccountHolder(req *CreateAccountHolderRequest, ctxs ..._context.Context) (CreateAccountHolderResponse, *_nethttp.Response, error) { - res := &CreateAccountHolderResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/createAccountHolder", ctxs...) - return *res, httpRes, err +func (a PlatformsAccount) CloseAccountHolder(req *CloseAccountHolderRequest, ctxs ..._context.Context) (CloseAccountHolderResponse, *_nethttp.Response, error) { + res := &CloseAccountHolderResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/closeAccountHolder", ctxs...) + return *res, httpRes, err } /* -CreateAccountPost Create a new account under an existing account holder. +PostCreateAccount Create a new account under an existing account holder. This endpoint is used to create an account under an existing account holder. An account holder may have multiple accounts. - * @param request CreateAccountRequest - reference of CreateAccountRequest). + * @param request CreateAccountRequest - reference of CreateAccountRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return CreateAccountResponse */ func (a PlatformsAccount) CreateAccount(req *CreateAccountRequest, ctxs ..._context.Context) (CreateAccountResponse, *_nethttp.Response, error) { - res := &CreateAccountResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/createAccount", ctxs...) - return *res, httpRes, err + res := &CreateAccountResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/createAccount", ctxs...) + return *res, httpRes, err +} + +/* +PostCreateAccountHolder Create a new account holder. +This endpoint is used to create an account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. Depending on the legal entity type, different details are required to be provided in the call to this endpoint. + * @param request CreateAccountHolderRequest - reference of CreateAccountHolderRequest). + * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return CreateAccountHolderResponse +*/ +func (a PlatformsAccount) CreateAccountHolder(req *CreateAccountHolderRequest, ctxs ..._context.Context) (CreateAccountHolderResponse, *_nethttp.Response, error) { + res := &CreateAccountHolderResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/createAccountHolder", ctxs...) + return *res, httpRes, err } /* -DeleteBankAccountsPost Delete bank accounts of an existing account holder. +PostDeleteBankAccounts Delete bank accounts of an existing account holder. This endpoint is used to delete existing bank accounts from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `bankAccountUUIDs` specifying bank accounts to delete. - * @param request DeleteBankAccountRequest - reference of DeleteBankAccountRequest). + * @param request DeleteBankAccountRequest - reference of DeleteBankAccountRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return GenericResponse */ func (a PlatformsAccount) DeleteBankAccounts(req *DeleteBankAccountRequest, ctxs ..._context.Context) (GenericResponse, *_nethttp.Response, error) { - res := &GenericResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/deleteBankAccounts", ctxs...) - return *res, httpRes, err + res := &GenericResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/deleteBankAccounts", ctxs...) + return *res, httpRes, err } /* -DeletePayoutMethodsPost Delete payout methods of an existing account holder. +PostDeletePayoutMethods Delete payout methods of an existing account holder. This endpoint is used to delete existing payout method from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `payoutMethodCodes` specifying payout methods to delete. - * @param request DeletePayoutMethodRequest - reference of DeletePayoutMethodRequest). + * @param request DeletePayoutMethodRequest - reference of DeletePayoutMethodRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return GenericResponse */ func (a PlatformsAccount) DeletePayoutMethods(req *DeletePayoutMethodRequest, ctxs ..._context.Context) (GenericResponse, *_nethttp.Response, error) { - res := &GenericResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/deletePayoutMethods", ctxs...) - return *res, httpRes, err + res := &GenericResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/deletePayoutMethods", ctxs...) + return *res, httpRes, err } /* -DeleteShareholdersPost Delete shareholders of an existing account holder. +PostDeleteShareholders Delete shareholders of an existing account holder. This endpoint is used to delete existing shareholders from an account holder. - * @param request DeleteShareholderRequest - reference of DeleteShareholderRequest). + * @param request DeleteShareholderRequest - reference of DeleteShareholderRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return GenericResponse */ func (a PlatformsAccount) DeleteShareholders(req *DeleteShareholderRequest, ctxs ..._context.Context) (GenericResponse, *_nethttp.Response, error) { - res := &GenericResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/deleteShareholders", ctxs...) - return *res, httpRes, err + res := &GenericResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/deleteShareholders", ctxs...) + return *res, httpRes, err } /* -GetAccountHolderPost Retrieve the details of an account holder. +PostGetAccountHolder Retrieve the details of an account holder. This endpoint is used to retrieve the details of an account holder. - * @param request GetAccountHolderRequest - reference of GetAccountHolderRequest). + * @param request GetAccountHolderRequest - reference of GetAccountHolderRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return GetAccountHolderResponse */ func (a PlatformsAccount) GetAccountHolder(req *GetAccountHolderRequest, ctxs ..._context.Context) (GetAccountHolderResponse, *_nethttp.Response, error) { - res := &GetAccountHolderResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/getAccountHolder", ctxs...) - return *res, httpRes, err + res := &GetAccountHolderResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/getAccountHolder", ctxs...) + return *res, httpRes, err } /* -GetUploadedDocumentsPost Retrieve the uploaded documents of an existing account holder. -This endpoint is used to retrieve documents previously uploaded for use in the KYC Verification of an account holder. For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks). - * @param request GetUploadedDocumentsRequest - reference of GetUploadedDocumentsRequest). +PostGetUploadedDocuments Retrieve the uploaded documents of an existing account holder. +This endpoint is used to retrieve documents previously uploaded for use in the KYC Verification of an account holder. For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). + * @param request GetUploadedDocumentsRequest - reference of GetUploadedDocumentsRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return GetUploadedDocumentsResponse */ func (a PlatformsAccount) GetUploadedDocuments(req *GetUploadedDocumentsRequest, ctxs ..._context.Context) (GetUploadedDocumentsResponse, *_nethttp.Response, error) { - res := &GetUploadedDocumentsResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/getUploadedDocuments", ctxs...) - return *res, httpRes, err + res := &GetUploadedDocumentsResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/getUploadedDocuments", ctxs...) + return *res, httpRes, err } /* -SuspendAccountHolderPost Suspend an existing account holder. +PostSuspendAccountHolder Suspend an existing account holder. This endpoint is used to suspend an existing account holder. If an account holder is suspended, it may not process transactions or pay out funds. Any payments made to a suspended account holder will be directed to the merchant's liable account. - * @param request SuspendAccountHolderRequest - reference of SuspendAccountHolderRequest). + * @param request SuspendAccountHolderRequest - reference of SuspendAccountHolderRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return SuspendAccountHolderResponse */ func (a PlatformsAccount) SuspendAccountHolder(req *SuspendAccountHolderRequest, ctxs ..._context.Context) (SuspendAccountHolderResponse, *_nethttp.Response, error) { - res := &SuspendAccountHolderResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/suspendAccountHolder", ctxs...) - return *res, httpRes, err + res := &SuspendAccountHolderResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/suspendAccountHolder", ctxs...) + return *res, httpRes, err } /* -UnSuspendAccountHolderPost Reinstate a disabled account holder. -This endpoint is used to reinstate an existing account holder, which has been suspended through the `/suspendAccountHolder` endpoint. An account holder which has been suspended due to KYC verification issues cannot be reinstated through this endpoint. - * @param request UnSuspendAccountHolderRequest - reference of UnSuspendAccountHolderRequest). +PostUnSuspendAccountHolder Reinstate a disabled account holder. +This endpoint is used to reinstate an existing account holder that has been suspended either through the `/suspendAccountHolder` endpoint or because a KYC deadline expired. However, an account holder that has been suspended by Adyen because of KYC verification issues (indicated by a **FAILED** verification [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)) cannot be reinstated through this endpoint. + * @param request UnSuspendAccountHolderRequest - reference of UnSuspendAccountHolderRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return UnSuspendAccountHolderResponse */ func (a PlatformsAccount) UnSuspendAccountHolder(req *UnSuspendAccountHolderRequest, ctxs ..._context.Context) (UnSuspendAccountHolderResponse, *_nethttp.Response, error) { - res := &UnSuspendAccountHolderResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/unSuspendAccountHolder", ctxs...) - return *res, httpRes, err + res := &UnSuspendAccountHolderResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/unSuspendAccountHolder", ctxs...) + return *res, httpRes, err } /* -UpdateAccountHolderPost Update an existing account holder. -This endpoint is used to update the `accountHolderDetails` or `processingTier` of an account holder. If updating the `accountHolderDetails`, only the details which have been provided will be updated. Other details will be left as-is with the exception of the following fields: * `accountHolderDetails.address` * `accountHolderDetails.fullPhoneNumber` * `accountHolderDetails.bankAccountDetails.BankAccountDetail` * `accountHolderDetails.businessDetails.shareholders.ShareholderContact`, which requires all fields necessary for validation (i.e. in order to update only the `accountHolderDetails.address.postalCode`, the fields `accountHolderDetails.address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` must be provided as well, so that the address can be properly validated). Note that this endpoint can also be used to create new bank accounts. For this, provide details of a bank account without providing a `bankAccountUUID`. Similarly, it can also be used to create new shareholders by providing details of a shareholder without providing a `shareholderCode`. > The updating of the `metadata` field will overwite all of the existing account holder metadata. In order to update an existing metadata key-value pair, all otherkey-value pairs should be provided in order to not delete them. - * @param request UpdateAccountHolderRequest - reference of UpdateAccountHolderRequest). +PostUpdateAccount Update an existing account under an account holder. +This endpoint is used to update the description or payout schedule of an existing account. + * @param request UpdateAccountRequest - reference of UpdateAccountRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return UpdateAccountHolderResponse +@return UpdateAccountResponse */ -func (a PlatformsAccount) UpdateAccountHolder(req *UpdateAccountHolderRequest, ctxs ..._context.Context) (UpdateAccountHolderResponse, *_nethttp.Response, error) { - res := &UpdateAccountHolderResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/updateAccountHolder", ctxs...) - return *res, httpRes, err +func (a PlatformsAccount) UpdateAccount(req *UpdateAccountRequest, ctxs ..._context.Context) (UpdateAccountResponse, *_nethttp.Response, error) { + res := &UpdateAccountResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/updateAccount", ctxs...) + return *res, httpRes, err } /* -UpdateAccountHolderStatePost Update the state of an existing account holder. -This endpoint is used to disable or enable the processing or payout state of an account holder. It cannot be used to enable an account holder whose processing or payout state has not been disabled through this endpoint. For more information about processing and payout states of an account holder, refer to [our documentation](https://docs.adyen.com/marketpay). - * @param request UpdateAccountHolderStateRequest - reference of UpdateAccountHolderStateRequest). +PostUpdateAccountHolder Update an existing account holder. +This endpoint is used to update the `accountHolderDetails` or `processingTier` of an account holder. If updating the `accountHolderDetails`, only the details which have been provided will be updated. Other details will be left as-is with the exception of the following fields: * `accountHolderDetails.address` * `accountHolderDetails.fullPhoneNumber` * `accountHolderDetails.bankAccountDetails.BankAccountDetail` * `accountHolderDetails.businessDetails.shareholders.ShareholderContact`, which requires all fields necessary for validation (i.e. in order to update only the `accountHolderDetails.address.postalCode`, the fields `accountHolderDetails.address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` must be provided as well, so that the address can be properly validated). Note that this endpoint can also be used to create new bank accounts. For this, provide details of a bank account without providing a `bankAccountUUID`. Similarly, it can also be used to create new shareholders by providing details of a shareholder without providing a `shareholderCode`. > The updating of the `metadata` field will overwite all of the existing account holder metadata. In order to update an existing metadata key-value pair, all otherkey-value pairs should be provided in order to not delete them. + * @param request UpdateAccountHolderRequest - reference of UpdateAccountHolderRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return GetAccountHolderStatusResponse +@return UpdateAccountHolderResponse */ -func (a PlatformsAccount) UpdateAccountHolderState(req *UpdateAccountHolderStateRequest, ctxs ..._context.Context) (GetAccountHolderStatusResponse, *_nethttp.Response, error) { - res := &GetAccountHolderStatusResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/updateAccountHolderState", ctxs...) - return *res, httpRes, err +func (a PlatformsAccount) UpdateAccountHolder(req *UpdateAccountHolderRequest, ctxs ..._context.Context) (UpdateAccountHolderResponse, *_nethttp.Response, error) { + res := &UpdateAccountHolderResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/updateAccountHolder", ctxs...) + return *res, httpRes, err } /* -UpdateAccountPost Update an existing account under an account holder. -This endpoint is used to update the description or payout schedule of an existing account. - * @param request UpdateAccountRequest - reference of UpdateAccountRequest). +PostUpdateAccountHolderState Update the state of an existing account holder. +This endpoint is used to disable or enable the processing or payout state of an account holder. For more information about processing and payout states of an account holder, refer to [our documentation](https://docs.adyen.com/platforms). + * @param request UpdateAccountHolderStateRequest - reference of UpdateAccountHolderStateRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return UpdateAccountResponse +@return GetAccountHolderStatusResponse */ -func (a PlatformsAccount) UpdateAccount(req *UpdateAccountRequest, ctxs ..._context.Context) (UpdateAccountResponse, *_nethttp.Response, error) { - res := &UpdateAccountResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/updateAccount", ctxs...) - return *res, httpRes, err +func (a PlatformsAccount) UpdateAccountHolderState(req *UpdateAccountHolderStateRequest, ctxs ..._context.Context) (GetAccountHolderStatusResponse, *_nethttp.Response, error) { + res := &GetAccountHolderStatusResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/updateAccountHolderState", ctxs...) + return *res, httpRes, err } /* -UploadDocumentPost Upload a document for an existing account holder. -This endpoint is used to upload a document for use in the KYC verification of an account holder. For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks). - * @param request UploadDocumentRequest - reference of UploadDocumentRequest). +PostUploadDocument Upload a document for an existing account holder. +This endpoint is used to upload a document for use in the KYC verification of an account holder. For further information regarding KYC Verification, please refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). + * @param request UploadDocumentRequest - reference of UploadDocumentRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return UpdateAccountHolderResponse */ func (a PlatformsAccount) UploadDocument(req *UploadDocumentRequest, ctxs ..._context.Context) (UpdateAccountHolderResponse, *_nethttp.Response, error) { - res := &UpdateAccountHolderResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/uploadDocument", ctxs...) - return *res, httpRes, err + res := &UpdateAccountHolderResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/uploadDocument", ctxs...) + return *res, httpRes, err } diff --git a/src/platformsaccount/model_account.go b/src/platformsaccount/model_account.go index 582eda07e..3f5600ede 100644 --- a/src/platformsaccount/model_account.go +++ b/src/platformsaccount/model_account.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,6 +13,8 @@ package platformsaccount type Account struct { // The code of the account. AccountCode string `json:"accountCode,omitempty"` + // The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + BankAccountUUID string `json:"bankAccountUUID,omitempty"` // The beneficiary of the account. BeneficiaryAccount string `json:"beneficiaryAccount,omitempty"` // The reason that a beneficiary has been set up for this account. This may have been supplied during the setup of a beneficiary at the discretion of the executing user. @@ -21,7 +23,11 @@ type Account struct { Description string `json:"description,omitempty"` // A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. Metadata map[string]string `json:"metadata,omitempty"` + // The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + PayoutMethodCode string `json:"payoutMethodCode,omitempty"` PayoutSchedule *PayoutScheduleResponse `json:"payoutSchedule,omitempty"` + // Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + PayoutSpeed string `json:"payoutSpeed,omitempty"` // The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`. Status string `json:"status,omitempty"` } diff --git a/src/platformsaccount/model_account_event.go b/src/platformsaccount/model_account_event.go index 438474a7c..f47c6afe7 100644 --- a/src/platformsaccount/model_account_event.go +++ b/src/platformsaccount/model_account_event.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,7 +14,7 @@ import ( ) // AccountEvent struct for AccountEvent type AccountEvent struct { - // The event. >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. For more information, refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks). + // The event. >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. For more information, refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). Event string `json:"event"` // The date on which the event will take place. ExecutionDate time.Time `json:"executionDate"` diff --git a/src/platformsaccount/model_account_holder_details.go b/src/platformsaccount/model_account_holder_details.go index 9f4521ffd..fb14266c0 100644 --- a/src/platformsaccount/model_account_holder_details.go +++ b/src/platformsaccount/model_account_holder_details.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,8 +12,10 @@ package platformsaccount // AccountHolderDetails struct for AccountHolderDetails type AccountHolderDetails struct { Address *ViasAddress `json:"address,omitempty"` - // Each of the bank accounts associated with the account holder. > Each array entry should represent one bank account. > For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks). + // Each of the bank accounts associated with the account holder. > Each array entry should represent one bank account. > For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). BankAccountDetails *[]BankAccountDetail `json:"bankAccountDetails,omitempty"` + // The opaque reference value returned by the Adyen API during bank account login. + BankAggregatorDataReference string `json:"bankAggregatorDataReference,omitempty"` BusinessDetails *BusinessDetails `json:"businessDetails,omitempty"` // The email address of the account holder. Email string `json:"email"` @@ -24,7 +26,7 @@ type AccountHolderDetails struct { MerchantCategoryCode string `json:"merchantCategoryCode,omitempty"` // A set of key and value pairs for general use by the account holder or merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. Metadata map[string]string `json:"metadata,omitempty"` - // Each of the card tokens associated with the account holder. > Each array entry should represent one card token. > For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks). + // Each of the card tokens associated with the account holder. > Each array entry should represent one card token. > For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). PayoutMethods *[]PayoutMethod `json:"payoutMethods,omitempty"` // The URL of the website of the account holder. WebAddress string `json:"webAddress"` diff --git a/src/platformsaccount/model_account_holder_status.go b/src/platformsaccount/model_account_holder_status.go index 7bcea07f4..06b233ca0 100644 --- a/src/platformsaccount/model_account_holder_status.go +++ b/src/platformsaccount/model_account_holder_status.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,11 +12,11 @@ package platformsaccount // AccountHolderStatus struct for AccountHolderStatus type AccountHolderStatus struct { // A list of events scheduled for the account holder. - Events []AccountEvent `json:"events"` - PayoutState AccountPayoutState `json:"payoutState"` - ProcessingState AccountProcessingState `json:"processingState"` + Events *[]AccountEvent `json:"events,omitempty"` + PayoutState *AccountPayoutState `json:"payoutState,omitempty"` + ProcessingState *AccountProcessingState `json:"processingState,omitempty"` // The status of the account holder. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`. Status string `json:"status"` // The reason why the status was assigned to the account holder. - StatusReason string `json:"statusReason"` + StatusReason string `json:"statusReason,omitempty"` } diff --git a/src/platformsaccount/model_account_payout_state.go b/src/platformsaccount/model_account_payout_state.go index dfe517da8..08608e9c3 100644 --- a/src/platformsaccount/model_account_payout_state.go +++ b/src/platformsaccount/model_account_payout_state.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,14 +12,14 @@ package platformsaccount // AccountPayoutState struct for AccountPayoutState type AccountPayoutState struct { // Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts. - AllowPayout bool `json:"allowPayout"` + AllowPayout bool `json:"allowPayout,omitempty"` // The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the `disabled` field is true, this field can be used to explain why. - DisableReason string `json:"disableReason"` + DisableReason string `json:"disableReason,omitempty"` // Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, `allowPayout` will be false and no payouts will be permitted for any of the account holder's accounts. If this field is false, `allowPayout` may or may not be enabled, depending on other factors. - Disabled bool `json:"disabled"` + Disabled bool `json:"disabled,omitempty"` // The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen. - NotAllowedReason string `json:"notAllowedReason"` - PayoutLimit Amount `json:"payoutLimit"` + NotAllowedReason string `json:"notAllowedReason,omitempty"` + PayoutLimit *Amount `json:"payoutLimit,omitempty"` // The payout tier that the account holder occupies. - TierNumber int32 `json:"tierNumber"` + TierNumber int32 `json:"tierNumber,omitempty"` } diff --git a/src/platformsaccount/model_account_processing_state.go b/src/platformsaccount/model_account_processing_state.go index 80580d11d..375ea834e 100644 --- a/src/platformsaccount/model_account_processing_state.go +++ b/src/platformsaccount/model_account_processing_state.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,11 +12,11 @@ package platformsaccount // AccountProcessingState struct for AccountProcessingState type AccountProcessingState struct { // The reason why processing has been disabled. - DisableReason string `json:"disableReason"` + DisableReason string `json:"disableReason,omitempty"` // Indicates whether the processing of payments is allowed. - Disabled bool `json:"disabled"` - ProcessedFrom Amount `json:"processedFrom"` - ProcessedTo Amount `json:"processedTo"` + Disabled bool `json:"disabled,omitempty"` + ProcessedFrom *Amount `json:"processedFrom,omitempty"` + ProcessedTo *Amount `json:"processedTo,omitempty"` // The processing tier that the account holder occupies. - TierNumber int32 `json:"tierNumber"` + TierNumber int32 `json:"tierNumber,omitempty"` } diff --git a/src/platformsaccount/model_amount.go b/src/platformsaccount/model_amount.go index 18641c933..0b8d7f3c3 100644 --- a/src/platformsaccount/model_amount.go +++ b/src/platformsaccount/model_amount.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,6 +13,6 @@ package platformsaccount type Amount struct { // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). Currency string `json:"currency"` - // The payable amount that can be charged for the transaction. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + // The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). Value int64 `json:"value"` } diff --git a/src/platformsaccount/model_bank_account_detail.go b/src/platformsaccount/model_bank_account_detail.go index f3fee843e..c1a8081a5 100644 --- a/src/platformsaccount/model_bank_account_detail.go +++ b/src/platformsaccount/model_bank_account_detail.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,9 +11,9 @@ package platformsaccount // BankAccountDetail struct for BankAccountDetail type BankAccountDetail struct { - // The bank account number (without separators). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The bank account number (without separators). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. AccountNumber string `json:"accountNumber,omitempty"` - // The type of bank account. Only applicable to bank accounts held in the USA. The permitted values are: `checking`, `savings`. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The type of bank account. Only applicable to bank accounts held in the USA. The permitted values are: `checking`, `savings`. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. AccountType string `json:"accountType,omitempty"` // The name of the bank account. BankAccountName string `json:"bankAccountName,omitempty"` @@ -21,46 +21,46 @@ type BankAccountDetail struct { BankAccountReference string `json:"bankAccountReference,omitempty"` // The unique identifier (UUID) of the Bank Account. >If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID. >If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue. >If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail. >If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated. BankAccountUUID string `json:"bankAccountUUID,omitempty"` - // The bank identifier code. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The bank identifier code. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. BankBicSwift string `json:"bankBicSwift,omitempty"` - // The city in which the bank branch is located. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The city in which the bank branch is located. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. BankCity string `json:"bankCity,omitempty"` - // The bank code of the banking institution with which the bank account is registered. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The bank code of the banking institution with which the bank account is registered. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. BankCode string `json:"bankCode,omitempty"` - // The name of the banking institution with which the bank account is held. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The name of the banking institution with which the bank account is held. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. BankName string `json:"bankName,omitempty"` - // The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account: * United States - Routing number * United Kingdom - Sort code * Germany - Bankleitzahl >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account: * United States - Routing number * United Kingdom - Sort code * Germany - Bankleitzahl >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. BranchCode string `json:"branchCode,omitempty"` - // The check code of the bank account. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The check code of the bank account. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. CheckCode string `json:"checkCode,omitempty"` - // The two-letter country code in which the bank account is registered. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The two-letter country code in which the bank account is registered. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. CountryCode string `json:"countryCode,omitempty"` - // The currency in which the bank account deals. >The permitted currency codes are defined in ISO-4217 (e.g. 'EUR'). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The currency in which the bank account deals. >The permitted currency codes are defined in ISO-4217 (e.g. 'EUR'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. CurrencyCode string `json:"currencyCode,omitempty"` - // The international bank account number. >The IBAN standard is defined in ISO-13616. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The international bank account number. >The IBAN standard is defined in ISO-13616. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. Iban string `json:"iban,omitempty"` - // The city of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The city of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerCity string `json:"ownerCity,omitempty"` - // The country code of the country of residence of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The country code of the country of residence of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerCountryCode string `json:"ownerCountryCode,omitempty"` // The date of birth of the bank account owner. OwnerDateOfBirth string `json:"ownerDateOfBirth,omitempty"` - // The house name or number of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The house name or number of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerHouseNumberOrName string `json:"ownerHouseNumberOrName,omitempty"` - // The name of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The name of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerName string `json:"ownerName,omitempty"` - // The country code of the country of nationality of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The country code of the country of nationality of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerNationality string `json:"ownerNationality,omitempty"` - // The postal code of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The postal code of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerPostalCode string `json:"ownerPostalCode,omitempty"` - // The state of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The state of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerState string `json:"ownerState,omitempty"` - // The street name of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The street name of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerStreet string `json:"ownerStreet,omitempty"` // If set to true, the bank account is a primary account. PrimaryAccount bool `json:"primaryAccount,omitempty"` - // The tax ID number. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The tax ID number. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. TaxId string `json:"taxId,omitempty"` - // The URL to be used for bank account verification. This may be generated on bank account creation. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The URL to be used for bank account verification. This may be generated on bank account creation. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. UrlForVerification string `json:"urlForVerification,omitempty"` } diff --git a/src/platformsaccount/model_business_details.go b/src/platformsaccount/model_business_details.go index d154eb09e..e6f905116 100644 --- a/src/platformsaccount/model_business_details.go +++ b/src/platformsaccount/model_business_details.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -19,6 +19,12 @@ type BusinessDetails struct { RegistrationNumber string `json:"registrationNumber,omitempty"` // Each of the shareholders associated with the company. Each array entry should represent one shareholder. Shareholders *[]ShareholderContact `json:"shareholders,omitempty"` + // Market Identifier Code (MIC). + StockExchange string `json:"stockExchange,omitempty"` + // International Securities Identification Number (ISIN). + StockNumber string `json:"stockNumber,omitempty"` + // Stock Ticker symbol. + StockTicker string `json:"stockTicker,omitempty"` // The tax ID of the company. TaxId string `json:"taxId,omitempty"` } diff --git a/src/platformsaccount/model_close_account_holder_request.go b/src/platformsaccount/model_close_account_holder_request.go index 2bd6cb9d7..a1d3ea572 100644 --- a/src/platformsaccount/model_close_account_holder_request.go +++ b/src/platformsaccount/model_close_account_holder_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_close_account_holder_response.go b/src/platformsaccount/model_close_account_holder_response.go index 4ccb34ecd..cbed93e03 100644 --- a/src/platformsaccount/model_close_account_holder_response.go +++ b/src/platformsaccount/model_close_account_holder_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,8 +14,8 @@ type CloseAccountHolderResponse struct { AccountHolderStatus AccountHolderStatus `json:"accountHolderStatus"` // 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"` + // 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"` } diff --git a/src/platformsaccount/model_close_account_request.go b/src/platformsaccount/model_close_account_request.go index bea0c34cb..098e700ea 100644 --- a/src/platformsaccount/model_close_account_request.go +++ b/src/platformsaccount/model_close_account_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_close_account_response.go b/src/platformsaccount/model_close_account_response.go index b80319326..4ea0f0155 100644 --- a/src/platformsaccount/model_close_account_response.go +++ b/src/platformsaccount/model_close_account_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,8 +15,8 @@ type CloseAccountResponse struct { AccountCode string `json:"accountCode,omitempty"` // 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"` + // 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"` // The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`. diff --git a/src/platformsaccount/model_create_account_holder_request.go b/src/platformsaccount/model_create_account_holder_request.go index 62af4b38d..6872747ce 100644 --- a/src/platformsaccount/model_create_account_holder_request.go +++ b/src/platformsaccount/model_create_account_holder_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,12 +16,14 @@ type CreateAccountHolderRequest struct { AccountHolderDetails AccountHolderDetails `json:"accountHolderDetails"` // If set to true, an account with the default options is created for this account holder. **Default Value:** true CreateDefaultAccount bool `json:"createDefaultAccount,omitempty"` - // A description of the prospective account holder. + // A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. Description string `json:"description,omitempty"` // The entity type. Permitted values: `Business`, `Individual` If an account holder is 'Business', then `accountHolderDetails.businessDetails` must be provided, as well as at least one entry in the `accountHolderDetails.businessDetails.shareholders` list. If an account holder is 'Individual', then `accountHolderDetails.individualDetails` must be provided. LegalEntity string `json:"legalEntity"` // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. PrimaryCurrency string `json:"primaryCurrency,omitempty"` - // The starting [processing tier](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks#tiers) for the prospective account holder. + // The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. ProcessingTier int32 `json:"processingTier,omitempty"` + // The identifier of the profile that applies to this entity. + VerificationProfile string `json:"verificationProfile,omitempty"` } diff --git a/src/platformsaccount/model_create_account_holder_response.go b/src/platformsaccount/model_create_account_holder_response.go index 6580d58e9..85b0e298d 100644 --- a/src/platformsaccount/model_create_account_holder_response.go +++ b/src/platformsaccount/model_create_account_holder_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -25,9 +25,11 @@ type CreateAccountHolderResponse struct { LegalEntity string `json:"legalEntity"` // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. PrimaryCurrency string `json:"primaryCurrency,omitempty"` - // The reference of a request. Can be used to uniquely identify the request. - PspReference string `json:"pspReference"` + // 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"` Verification KYCVerificationResult `json:"verification"` + // The identifier of the profile that applies to this entity. + VerificationProfile string `json:"verificationProfile,omitempty"` } diff --git a/src/platformsaccount/model_create_account_request.go b/src/platformsaccount/model_create_account_request.go index f1860db0d..ea2a8e81a 100644 --- a/src/platformsaccount/model_create_account_request.go +++ b/src/platformsaccount/model_create_account_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,12 +13,18 @@ package platformsaccount type CreateAccountRequest struct { // The code of Account Holder under which to create the account. AccountHolderCode string `json:"accountHolderCode"` - // A description of the account. + // The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + BankAccountUUID string `json:"bankAccountUUID,omitempty"` + // A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. Description string `json:"description,omitempty"` // A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. Metadata map[string]string `json:"metadata,omitempty"` + // The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + PayoutMethodCode string `json:"payoutMethodCode,omitempty"` // The payout schedule of the prospective account. >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. PayoutSchedule string `json:"payoutSchedule,omitempty"` // The reason for the payout schedule choice. >Required if the payoutSchedule is `HOLD`. PayoutScheduleReason string `json:"payoutScheduleReason,omitempty"` + // Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + PayoutSpeed string `json:"payoutSpeed,omitempty"` } diff --git a/src/platformsaccount/model_create_account_response.go b/src/platformsaccount/model_create_account_response.go index 172460658..29726b032 100644 --- a/src/platformsaccount/model_create_account_response.go +++ b/src/platformsaccount/model_create_account_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,14 +15,20 @@ type CreateAccountResponse struct { AccountCode string `json:"accountCode"` // The code of the account holder. AccountHolderCode string `json:"accountHolderCode"` + // The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + BankAccountUUID string `json:"bankAccountUUID,omitempty"` // The description of the account. Description string `json:"description,omitempty"` // A list of fields that caused the `/createAccount` request to fail. InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` Metadata map[string]string `json:"metadata,omitempty"` + // The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + PayoutMethodCode string `json:"payoutMethodCode,omitempty"` PayoutSchedule *PayoutScheduleResponse `json:"payoutSchedule,omitempty"` - // The reference of a request. Can be used to uniquely identify the request. - PspReference string `json:"pspReference"` + // Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + PayoutSpeed string `json:"payoutSpeed,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"` // The status of the account. >Permitted values: `Active`. diff --git a/src/platformsaccount/model_delete_bank_account_request.go b/src/platformsaccount/model_delete_bank_account_request.go index 038f0119f..2b63e82b8 100644 --- a/src/platformsaccount/model_delete_bank_account_request.go +++ b/src/platformsaccount/model_delete_bank_account_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_delete_payout_method_request.go b/src/platformsaccount/model_delete_payout_method_request.go index 3805d9389..f1bbb7a31 100644 --- a/src/platformsaccount/model_delete_payout_method_request.go +++ b/src/platformsaccount/model_delete_payout_method_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_delete_shareholder_request.go b/src/platformsaccount/model_delete_shareholder_request.go index c1a75ecf4..a0a0a3c7d 100644 --- a/src/platformsaccount/model_delete_shareholder_request.go +++ b/src/platformsaccount/model_delete_shareholder_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_document_detail.go b/src/platformsaccount/model_document_detail.go index 6c428b9d1..98867bcbe 100644 --- a/src/platformsaccount/model_document_detail.go +++ b/src/platformsaccount/model_document_detail.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,14 +13,14 @@ package platformsaccount type DocumentDetail struct { // The code of account holder, to which the document applies. AccountHolderCode string `json:"accountHolderCode"` - // The unique ID of the Bank Account to which the document applies. >Required if the documentType is `BANK_STATEMENT` (i.e., a document is being submitted in order to verify a bank account). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account. + // The unique ID of the Bank Account to which the document applies. >Required if the documentType is `BANK_STATEMENT` (i.e., a document is being submitted in order to verify a bank account). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account. BankAccountUUID string `json:"bankAccountUUID,omitempty"` // Description of the document. Description string `json:"description,omitempty"` - // The type of a document. Permitted values: * `BANK_STATEMENT` denotes an image containing a bank statement or other document proving ownership of a specific bank account. * `PASSPORT` denotes an image containing the identity page(s) of a passport. * `ID_CARD_FRONT` denotes an image containing only the front of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted. * `ID_CARD_BACK` denotes an image containing only the back of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted. * `DRIVING_LICENCE_FRONT` denotes an image containing only the front of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_BACK` must be submitted. * `DRIVING_LICENCE_BACK` denotes an image containing only the back of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_FRONT` must be submitted. >Please refer to [Verification checks](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks) for details on when each document type should be submitted. + // The type of a document. Permitted values: * `BANK_STATEMENT` denotes an image containing a bank statement or other document proving ownership of a specific bank account. * `PASSPORT` denotes an image containing the identity page(s) of a passport. * `ID_CARD_FRONT` denotes an image containing only the front of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted. * `ID_CARD_BACK` denotes an image containing only the back of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted. * `DRIVING_LICENCE_FRONT` denotes an image containing only the front of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_BACK` must be submitted. * `DRIVING_LICENCE_BACK` denotes an image containing only the back of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_FRONT` must be submitted. >Please refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks) for details on when each document type should be submitted. DocumentType string `json:"documentType"` // Filename of the document. Filename string `json:"filename"` - // The code of the shareholder, to which the document applies. >Required if the account holder referred to by the `accountHolderCode` has a `legalEntity` of type `Business` and the `documentType` is either `PASSPORT`, `ID_CARD_FRONT`, `ID_CARD_BACK`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK` (i.e. a document is being submitted in order to verify a shareholder). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder. + // The code of the shareholder, to which the document applies. >Required if the account holder referred to by the `accountHolderCode` has a `legalEntity` of type `Business` and the `documentType` is either `PASSPORT`, `ID_CARD_FRONT`, `ID_CARD_BACK`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK` (i.e. a document is being submitted in order to verify a shareholder). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder. ShareholderCode string `json:"shareholderCode,omitempty"` } diff --git a/src/platformsaccount/model_error_field_type.go b/src/platformsaccount/model_error_field_type.go index 095587171..3f50a87bd 100644 --- a/src/platformsaccount/model_error_field_type.go +++ b/src/platformsaccount/model_error_field_type.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_field_type.go b/src/platformsaccount/model_field_type.go index b0a0ff3b8..9877d85f6 100644 --- a/src/platformsaccount/model_field_type.go +++ b/src/platformsaccount/model_field_type.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_generic_response.go b/src/platformsaccount/model_generic_response.go index 162b45aa6..ed468fd42 100644 --- a/src/platformsaccount/model_generic_response.go +++ b/src/platformsaccount/model_generic_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,8 +13,8 @@ package platformsaccount 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"` + // 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"` } diff --git a/src/platformsaccount/model_get_account_holder_request.go b/src/platformsaccount/model_get_account_holder_request.go index b30f4840e..7d1de1d42 100644 --- a/src/platformsaccount/model_get_account_holder_request.go +++ b/src/platformsaccount/model_get_account_holder_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_get_account_holder_response.go b/src/platformsaccount/model_get_account_holder_response.go index 07b5974d9..1f3bcea9f 100644 --- a/src/platformsaccount/model_get_account_holder_response.go +++ b/src/platformsaccount/model_get_account_holder_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -28,11 +28,13 @@ type GetAccountHolderResponse struct { LegalEntity string `json:"legalEntity"` // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. PrimaryCurrency string `json:"primaryCurrency,omitempty"` - // The reference of a request. Can be used to uniquely identify the request. - PspReference string `json:"pspReference"` + // 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"` // The time that shows how up to date is the information in the response. SystemUpToDateTime *time.Time `json:"systemUpToDateTime,omitempty"` Verification KYCVerificationResult `json:"verification"` + // The identifier of the profile that applies to this entity. + VerificationProfile string `json:"verificationProfile,omitempty"` } diff --git a/src/platformsaccount/model_get_account_holder_status_response.go b/src/platformsaccount/model_get_account_holder_status_response.go index afe9739e3..36aa280ea 100644 --- a/src/platformsaccount/model_get_account_holder_status_response.go +++ b/src/platformsaccount/model_get_account_holder_status_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -16,8 +16,8 @@ type GetAccountHolderStatusResponse struct { AccountHolderStatus AccountHolderStatus `json:"accountHolderStatus"` // 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"` + // 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"` } diff --git a/src/platformsaccount/model_get_uploaded_documents_request.go b/src/platformsaccount/model_get_uploaded_documents_request.go index c9b371533..6e7663d3d 100644 --- a/src/platformsaccount/model_get_uploaded_documents_request.go +++ b/src/platformsaccount/model_get_uploaded_documents_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_get_uploaded_documents_response.go b/src/platformsaccount/model_get_uploaded_documents_response.go index 0d8ad67f7..4533c06fd 100644 --- a/src/platformsaccount/model_get_uploaded_documents_response.go +++ b/src/platformsaccount/model_get_uploaded_documents_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,8 +15,8 @@ type GetUploadedDocumentsResponse struct { DocumentDetails *[]DocumentDetail `json:"documentDetails,omitempty"` // 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"` + // 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"` } diff --git a/src/platformsaccount/model_individual_details.go b/src/platformsaccount/model_individual_details.go index b3d066fa8..2623936cf 100644 --- a/src/platformsaccount/model_individual_details.go +++ b/src/platformsaccount/model_individual_details.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_kyc_check_result.go b/src/platformsaccount/model_kyc_check_result.go index c95ceb5d5..7d3aad4db 100644 --- a/src/platformsaccount/model_kyc_check_result.go +++ b/src/platformsaccount/model_kyc_check_result.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,5 +12,5 @@ package platformsaccount // KYCCheckResult struct for KYCCheckResult type KYCCheckResult struct { // A list of the checks and their statuses. - Checks []KYCCheckStatusData `json:"checks"` + Checks *[]KYCCheckStatusData `json:"checks,omitempty"` } diff --git a/src/platformsaccount/model_kyc_check_status_data.go b/src/platformsaccount/model_kyc_check_status_data.go index 0f4627f45..27e10a29d 100644 --- a/src/platformsaccount/model_kyc_check_status_data.go +++ b/src/platformsaccount/model_kyc_check_status_data.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,10 +12,10 @@ package platformsaccount // KYCCheckStatusData struct for KYCCheckStatusData type KYCCheckStatusData struct { // A list of the fields required for execution of the check. - RequiredFields []string `json:"requiredFields"` + RequiredFields []string `json:"requiredFields,omitempty"` // The status of the check. >Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`. Status string `json:"status"` - Summary KYCCheckSummary `json:"summary"` + Summary *KYCCheckSummary `json:"summary,omitempty"` // The type of check. >Permitted Values: `COMPANY_VERIFICATION`, `IDENTITY_VERIFICATION`, `PASSPORT_VERIFICATION`, `BANK_ACCOUNT_VERIFICATION`, `NONPROFIT_VERIFICATION`, `CARD_VERIFICATION`. Type string `json:"type"` } diff --git a/src/platformsaccount/model_kyc_check_summary.go b/src/platformsaccount/model_kyc_check_summary.go index fcdde4cb7..570eb611d 100644 --- a/src/platformsaccount/model_kyc_check_summary.go +++ b/src/platformsaccount/model_kyc_check_summary.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_kyc_payout_method_check_result.go b/src/platformsaccount/model_kyc_payout_method_check_result.go new file mode 100644 index 000000000..b8a5b0c1d --- /dev/null +++ b/src/platformsaccount/model_kyc_payout_method_check_result.go @@ -0,0 +1,18 @@ +/* + * Adyen for Platforms: Account API + * + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` + * + * API version: 6 + * Contact: support@adyen.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package platformsaccount +// KYCPayoutMethodCheckResult struct for KYCPayoutMethodCheckResult +type KYCPayoutMethodCheckResult struct { + // A list of the checks and their statuses. + Checks *[]KYCCheckStatusData `json:"checks,omitempty"` + // The unique ID of the payoput method to which the check applies. + PayoutMethodCode string `json:"payoutMethodCode,omitempty"` +} diff --git a/src/platformsaccount/model_kyc_shareholder_check_result.go b/src/platformsaccount/model_kyc_shareholder_check_result.go index f9fbc1fce..f1d176b27 100644 --- a/src/platformsaccount/model_kyc_shareholder_check_result.go +++ b/src/platformsaccount/model_kyc_shareholder_check_result.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -12,7 +12,7 @@ package platformsaccount // KYCShareholderCheckResult struct for KYCShareholderCheckResult type KYCShareholderCheckResult struct { // A list of the checks and their statuses. - Checks []KYCCheckStatusData `json:"checks"` + Checks *[]KYCCheckStatusData `json:"checks,omitempty"` // The code of the shareholder to which the check applies. - ShareholderCode string `json:"shareholderCode"` + ShareholderCode string `json:"shareholderCode,omitempty"` } diff --git a/src/platformsaccount/model_kyc_verification_result.go b/src/platformsaccount/model_kyc_verification_result.go index 2e4a2c6b5..95053351c 100644 --- a/src/platformsaccount/model_kyc_verification_result.go +++ b/src/platformsaccount/model_kyc_verification_result.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,11 +11,9 @@ package platformsaccount // KYCVerificationResult struct for KYCVerificationResult type KYCVerificationResult struct { - AccountHolder KYCCheckResult `json:"accountHolder"` - // The result(s) of the checks on the bank account(s). - BankAccounts []KYCBankAccountCheckResult `json:"bankAccounts"` - // The result(s) of the checks on the card(s). - Cards []KYCCardCheckResult `json:"cards"` + AccountHolder *KYCCheckResult `json:"accountHolder,omitempty"` + // The result(s) of the checks on the payout method(s). + PayoutMethods *[]KYCPayoutMethodCheckResult `json:"payoutMethods,omitempty"` // The result(s) of the checks on the shareholder(s). - Shareholders []KYCShareholderCheckResult `json:"shareholders"` + Shareholders *[]KYCShareholderCheckResult `json:"shareholders,omitempty"` } diff --git a/src/platformsaccount/model_payout_method.go b/src/platformsaccount/model_payout_method.go index 7b0a23d76..4b86811ec 100644 --- a/src/platformsaccount/model_payout_method.go +++ b/src/platformsaccount/model_payout_method.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_payout_schedule_response.go b/src/platformsaccount/model_payout_schedule_response.go index 112118ab8..0ff461906 100644 --- a/src/platformsaccount/model_payout_schedule_response.go +++ b/src/platformsaccount/model_payout_schedule_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_perform_verification_request.go b/src/platformsaccount/model_perform_verification_request.go index 97d52b4b8..3a2b166cd 100644 --- a/src/platformsaccount/model_perform_verification_request.go +++ b/src/platformsaccount/model_perform_verification_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_personal_document_data.go b/src/platformsaccount/model_personal_document_data.go index d5be64678..3e7e94bf5 100644 --- a/src/platformsaccount/model_personal_document_data.go +++ b/src/platformsaccount/model_personal_document_data.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,7 +18,7 @@ type PersonalDocumentData struct { // The state issued the document (if applicable) IssuerState string `json:"issuerState,omitempty"` // The number of the document. Delete the given type if the value empty. - Number string `json:"number"` + Number string `json:"number,omitempty"` // The type of the document. More then one item pert type does not allowed. Valid values: ID, PASSPORT, VISA, DRIVINGLICENSE Type string `json:"type"` } diff --git a/src/platformsaccount/model_shareholder_contact.go b/src/platformsaccount/model_shareholder_contact.go index be8e4cccb..1fa6d1520 100644 --- a/src/platformsaccount/model_shareholder_contact.go +++ b/src/platformsaccount/model_shareholder_contact.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_suspend_account_holder_request.go b/src/platformsaccount/model_suspend_account_holder_request.go index bb808ae8b..9e06ce83e 100644 --- a/src/platformsaccount/model_suspend_account_holder_request.go +++ b/src/platformsaccount/model_suspend_account_holder_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_suspend_account_holder_response.go b/src/platformsaccount/model_suspend_account_holder_response.go index f8871e431..fefff416f 100644 --- a/src/platformsaccount/model_suspend_account_holder_response.go +++ b/src/platformsaccount/model_suspend_account_holder_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,8 +14,8 @@ type SuspendAccountHolderResponse struct { AccountHolderStatus AccountHolderStatus `json:"accountHolderStatus"` // 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"` + // 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"` } diff --git a/src/platformsaccount/model_un_suspend_account_holder_request.go b/src/platformsaccount/model_un_suspend_account_holder_request.go index afe31c8a0..24c96ab1c 100644 --- a/src/platformsaccount/model_un_suspend_account_holder_request.go +++ b/src/platformsaccount/model_un_suspend_account_holder_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_un_suspend_account_holder_response.go b/src/platformsaccount/model_un_suspend_account_holder_response.go index 505845c65..7f48c4c34 100644 --- a/src/platformsaccount/model_un_suspend_account_holder_response.go +++ b/src/platformsaccount/model_un_suspend_account_holder_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,8 +14,8 @@ type UnSuspendAccountHolderResponse struct { AccountHolderStatus AccountHolderStatus `json:"accountHolderStatus"` // 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"` + // 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"` } diff --git a/src/platformsaccount/model_update_account_holder_request.go b/src/platformsaccount/model_update_account_holder_request.go index 6d2ac65d0..4a9cae7da 100644 --- a/src/platformsaccount/model_update_account_holder_request.go +++ b/src/platformsaccount/model_update_account_holder_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,7 +14,7 @@ type UpdateAccountHolderRequest struct { // The code of the Account Holder to be updated. AccountHolderCode string `json:"accountHolderCode"` AccountHolderDetails *AccountHolderDetails `json:"accountHolderDetails,omitempty"` - // The description to which the Account Holder should be updated. + // A description of the account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. Description string `json:"description,omitempty"` // The entity type. Permitted values: `Business`, `Individual` If an account holder is 'Business', then `accountHolderDetails.businessDetails` must be provided, as well as at least one entry in the `accountHolderDetails.businessDetails.shareholders` list. If an account holder is 'Individual', then `accountHolderDetails.individualDetails` must be provided. LegalEntity string `json:"legalEntity,omitempty"` @@ -22,4 +22,6 @@ type UpdateAccountHolderRequest struct { PrimaryCurrency string `json:"primaryCurrency,omitempty"` // The processing tier to which the Account Holder should be updated. >The processing tier can not be lowered through this request. >Required if accountHolderDetails are not provided. ProcessingTier int32 `json:"processingTier,omitempty"` + // The identifier of the profile that applies to this entity. + VerificationProfile string `json:"verificationProfile,omitempty"` } diff --git a/src/platformsaccount/model_update_account_holder_response.go b/src/platformsaccount/model_update_account_holder_response.go index 8ef46c97c..be0a0cb1a 100644 --- a/src/platformsaccount/model_update_account_holder_response.go +++ b/src/platformsaccount/model_update_account_holder_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -23,9 +23,11 @@ type UpdateAccountHolderResponse struct { LegalEntity string `json:"legalEntity"` // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. PrimaryCurrency string `json:"primaryCurrency,omitempty"` - // The reference of a request. Can be used to uniquely identify the request. - PspReference string `json:"pspReference"` + // 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"` Verification KYCVerificationResult `json:"verification"` + // The identifier of the profile that applies to this entity. + VerificationProfile string `json:"verificationProfile,omitempty"` } diff --git a/src/platformsaccount/model_update_account_holder_state_request.go b/src/platformsaccount/model_update_account_holder_state_request.go index 983d2367e..1429ab258 100644 --- a/src/platformsaccount/model_update_account_holder_state_request.go +++ b/src/platformsaccount/model_update_account_holder_state_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_update_account_request.go b/src/platformsaccount/model_update_account_request.go index 6362d7eca..02eddd10c 100644 --- a/src/platformsaccount/model_update_account_request.go +++ b/src/platformsaccount/model_update_account_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,9 +13,15 @@ package platformsaccount type UpdateAccountRequest struct { // The code of the account to update. AccountCode string `json:"accountCode"` - // A description of the account. + // The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + BankAccountUUID string `json:"bankAccountUUID,omitempty"` + // A description of the account, maximum 256 characters.You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. Description string `json:"description,omitempty"` // A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. Metadata map[string]string `json:"metadata,omitempty"` + // The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + PayoutMethodCode string `json:"payoutMethodCode,omitempty"` PayoutSchedule *UpdatePayoutScheduleRequest `json:"payoutSchedule,omitempty"` + // Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + PayoutSpeed string `json:"payoutSpeed,omitempty"` } diff --git a/src/platformsaccount/model_update_account_response.go b/src/platformsaccount/model_update_account_response.go index a51ce50a5..37a0ec930 100644 --- a/src/platformsaccount/model_update_account_response.go +++ b/src/platformsaccount/model_update_account_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,14 +13,20 @@ package platformsaccount type UpdateAccountResponse struct { // The code of the account. AccountCode string `json:"accountCode"` + // The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + BankAccountUUID string `json:"bankAccountUUID,omitempty"` // The description of the account. Description string `json:"description,omitempty"` // A list of fields that caused the `/updateAccount` request to fail. InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` Metadata map[string]string `json:"metadata,omitempty"` - PayoutSchedule PayoutScheduleResponse `json:"payoutSchedule"` - // The reference of a request. Can be used to uniquely identify the request. - PspReference string `json:"pspReference"` + // The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + PayoutMethodCode string `json:"payoutMethodCode,omitempty"` + PayoutSchedule *PayoutScheduleResponse `json:"payoutSchedule,omitempty"` + // Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + PayoutSpeed string `json:"payoutSpeed,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"` } diff --git a/src/platformsaccount/model_update_payout_schedule_request.go b/src/platformsaccount/model_update_payout_schedule_request.go index ec04b5af2..1b7fdd68b 100644 --- a/src/platformsaccount/model_update_payout_schedule_request.go +++ b/src/platformsaccount/model_update_payout_schedule_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_upload_document_request.go b/src/platformsaccount/model_upload_document_request.go index 538dde1d4..7d24d9eae 100644 --- a/src/platformsaccount/model_upload_document_request.go +++ b/src/platformsaccount/model_upload_document_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,7 +11,7 @@ package platformsaccount // UploadDocumentRequest struct for UploadDocumentRequest type UploadDocumentRequest struct { - // The content of the document as represented by a Base64-encoded string. To learn about requirements, see [Bank account check](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks/bank-account-check#requirements) and [Photo ID check](https://docs.adyen.com/marketpay/onboarding-and-verification/verification-checks/photo-id-check#requirements). + // The content of the document as represented by a Base64-encoded string. To learn about requirements, see [Bank account check](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks/bank-account-check#requirements) and [Photo ID check](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks/photo-id-check#requirements). DocumentContent string `json:"documentContent"` DocumentDetail DocumentDetail `json:"documentDetail"` } diff --git a/src/platformsaccount/model_vias_address.go b/src/platformsaccount/model_vias_address.go index 2a83b520e..9325d74ac 100644 --- a/src/platformsaccount/model_vias_address.go +++ b/src/platformsaccount/model_vias_address.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_vias_name.go b/src/platformsaccount/model_vias_name.go index dfd073b97..68336979f 100644 --- a/src/platformsaccount/model_vias_name.go +++ b/src/platformsaccount/model_vias_name.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_vias_personal_data.go b/src/platformsaccount/model_vias_personal_data.go index 2f5428434..f91222b9d 100644 --- a/src/platformsaccount/model_vias_personal_data.go +++ b/src/platformsaccount/model_vias_personal_data.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsaccount/model_vias_phone_number.go b/src/platformsaccount/model_vias_phone_number.go index 1292662c7..51099e02b 100644 --- a/src/platformsaccount/model_vias_phone_number.go +++ b/src/platformsaccount/model_vias_phone_number.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Account API * - * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v5/createAccountHolder ``` + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account 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/Account/v6/createAccountHolder ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/.openapi-generator/VERSION b/src/platformsfund/.openapi-generator/VERSION index ecedc98d1..b5d898602 100644 --- a/src/platformsfund/.openapi-generator/VERSION +++ b/src/platformsfund/.openapi-generator/VERSION @@ -1 +1 @@ -4.3.1 \ No newline at end of file +4.3.1-SNAPSHOT \ No newline at end of file diff --git a/src/platformsfund/README.md b/src/platformsfund/README.md index 036ea05cb..4f0caa6d2 100644 --- a/src/platformsfund/README.md +++ b/src/platformsfund/README.md @@ -2,7 +2,7 @@ The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. -For more information, refer to our [documentation](https://docs.adyen.com/marketpay). +For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: @@ -19,13 +19,13 @@ The Fund API supports versioning of its endpoints through a version suffix in th For example: ``` -https://cal-test.adyen.com/cal/services/Fund/v5/accountHolderBalance +https://cal-test.adyen.com/cal/services/Fund/v6/accountHolderBalance ``` ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 5 +- API version: 6 - Package version: 1.0.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit [https://support.adyen.com/](https://support.adyen.com/) diff --git a/src/platformsfund/api/openapi.yaml b/src/platformsfund/api/openapi.yaml index 1a0508a8a..b6604de6e 100644 --- a/src/platformsfund/api/openapi.yaml +++ b/src/platformsfund/api/openapi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.0.3 info: contact: email: support@adyen.com @@ -7,7 +7,7 @@ info: description: |- The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. - For more information, refer to our [documentation](https://docs.adyen.com/marketpay). + For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: @@ -24,19 +24,20 @@ info: For example: ``` - https://cal-test.adyen.com/cal/services/Fund/v5/accountHolderBalance + https://cal-test.adyen.com/cal/services/Fund/v6/accountHolderBalance ``` termsOfService: https://www.adyen.com/legal/terms-and-conditions title: 'Adyen for Platforms: Fund API' - version: "5" + version: "6" servers: -- url: https://cal-test.adyen.com/cal/services/Fund/v5 +- url: https://cal-test.adyen.com/cal/services/Fund/v6 paths: /accountHolderBalance: post: description: 'This endpoint is used to retrieve the balance(s) of the accounts of an account holder. An account''s balances are on a per-currency basis (i.e., an account may have multiple balances: one per currency).' + operationId: post-accountHolderBalance requestBody: content: application/json: @@ -51,14 +52,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Retrieve the balance(s) of an account holder. x-groupName: General x-sortIndex: 1 @@ -70,6 +71,7 @@ paths: Transactions per account; in order to retrieve the following set of Transactions another call should be made with the 'page' value incremented. Note that Transactions are ordered with most recent first. + operationId: post-accountHolderTransactionList requestBody: content: application/json: @@ -84,14 +86,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Retrieve a list of transactions. x-groupName: General x-sortIndex: 2 @@ -99,6 +101,7 @@ paths: post: description: This endpoint is used to pay out a specified amount from an account to the bank account of the account's account holder. + operationId: post-payoutAccountHolder requestBody: content: application/json: @@ -113,14 +116,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Disburse a specified amount from an account to the account holder. x-groupName: General x-sortIndex: 3 @@ -129,6 +132,7 @@ paths: description: 'This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders. ' + operationId: post-refundFundsTransfer requestBody: content: application/json: @@ -143,14 +147,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Make a refund of the existing transfer funds transfer. x-groupName: General x-sortIndex: 5 @@ -163,6 +167,7 @@ paths: commission(s), fee(s), and payment(s) to other account(s), will remain in the accounts to which they were sent as designated by the original payment's split details. + operationId: post-refundNotPaidOutTransfers requestBody: content: application/json: @@ -177,14 +182,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Refund all transactions of an account since the most recent payout. x-groupName: General x-sortIndex: 7 @@ -196,6 +201,7 @@ paths: and any further payments to the benefactor account are automatically sent to the beneficiary account. Note that a series of benefactor/beneficiaries may not exceed four (4) beneficiaries and may not have a cycle in it. + operationId: post-setupBeneficiary requestBody: content: application/json: @@ -210,14 +216,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary. x-groupName: General @@ -228,6 +234,7 @@ paths: account. Both accounts must be in the same marketplace, but can have different account holders. The transfer must include a transfer code, which should be determined by the marketplace, in compliance with local regulations. + operationId: post-transferFunds requestBody: content: application/json: @@ -242,14 +249,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Transfer funds from one platform account to another. x-groupName: General x-sortIndex: 4 @@ -370,7 +377,7 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -378,8 +385,6 @@ components: type: string totalBalance: $ref: '#/components/schemas/DetailBalance' - required: - - pspReference AccountHolderTransactionListRequest: example: transactionListsPerAccount: @@ -411,6 +416,8 @@ components: >* `CreditFailed` - a pending credit failure; the balance will not be credited. >* `Credited` - a credited balance. >* `PendingDebit` - a pending balance debit (e.g., a refund). + >* `CreditClosed` - a pending credit closed; the balance will not be credited. + >* `CreditSuspended` - a pending credit closed; the balance will not be credited. >* `DebitFailed` - a pending debit failure; the balance will not be debited. >* `Debited` - a debited balance (e.g., a refund). >* `DebitReversedReceived` - a pending refund reversal. @@ -432,11 +439,15 @@ components: - ChargebackCorrectionReceived - ChargebackReceived - ChargebackReversed + - ChargebackReversedCorrection + - ChargebackReversedCorrectionReceived - ChargebackReversedReceived - Converted + - CreditClosed - CreditFailed - CreditReversed - CreditReversedReceived + - CreditSuspended - Credited - DebitFailed - DebitReversedReceived @@ -446,6 +457,8 @@ components: - FundTransfer - FundTransferReversed - ManualCorrected + - ManualCorrectionCredited + - ManualCorrectionDebited - Payout - PayoutReversed - PendingCredit @@ -670,14 +683,12 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: description: The result code. type: string - required: - - pspReference AccountTransactionList: example: accountCode: accountCode @@ -794,10 +805,7 @@ components: minLength: 3 type: string value: - description: |- - The payable amount that can be charged for the transaction. - - The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). format: int64 type: integer required: @@ -835,7 +843,7 @@ components: accountNumber: description: |- The bank account number (without separators). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string accountType: description: |- @@ -843,7 +851,7 @@ components: Only applicable to bank accounts held in the USA. The permitted values are: `checking`, `savings`. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string bankAccountName: description: The name of the bank account. @@ -865,25 +873,25 @@ components: bankBicSwift: description: |- The bank identifier code. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string bankCity: description: |- The city in which the bank branch is located. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string bankCode: description: |- The bank code of the banking institution with which the bank account is registered. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string bankName: description: |- The name of the banking institution with which the bank account is held. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string branchCode: description: |- @@ -891,46 +899,46 @@ components: * United States - Routing number * United Kingdom - Sort code * Germany - Bankleitzahl - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string checkCode: description: |- The check code of the bank account. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string countryCode: description: |- The two-letter country code in which the bank account is registered. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string currencyCode: description: |- The currency in which the bank account deals. >The permitted currency codes are defined in ISO-4217 (e.g. 'EUR'). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string iban: description: |- The international bank account number. >The IBAN standard is defined in ISO-13616. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerCity: description: |- The city of residence of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerCountryCode: description: |- The country code of the country of residence of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerDateOfBirth: description: | @@ -939,34 +947,34 @@ components: ownerHouseNumberOrName: description: |- The house name or number of the residence of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerName: description: |- The name of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerNationality: description: |- The country code of the country of nationality of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerPostalCode: description: |- The postal code of the residence of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerState: description: |- The state of residence of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string ownerStreet: description: |- The street name of the residence of the bank account owner. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string primaryAccount: description: If set to true, the bank account is a primary account. @@ -975,14 +983,14 @@ components: description: |- The tax ID number. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string urlForVerification: description: |- The URL to be used for bank account verification. This may be generated on bank account creation. - >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. type: string DetailBalance: example: @@ -1090,6 +1098,7 @@ components: - drivingLicense - email - firstName + - formType - fullPhoneNumber - gender - hopWebserviceUser @@ -1137,6 +1146,9 @@ components: - sourceAccountCode - stateOrProvince - status + - stockExchange + - stockNumber + - stockTicker - store - storeDetail - storeName @@ -1151,6 +1163,7 @@ components: - virtualAccount - visaNumber - webAddress + - year type: string shareholderCode: description: The code of the shareholder that the field belongs to. If empty, @@ -1167,6 +1180,7 @@ components: payoutMethodCode: payoutMethodCode description: description merchantReference: merchantReference + payoutSpeed: STANDARD properties: accountCode: description: The code of the account from which the payout is to be made. @@ -1197,6 +1211,14 @@ components: The unique ID of the payout method held by the Account Holder to which the payout is to be made. If left blank, a payout instrument is automatically selected. type: string + payoutSpeed: + default: STANDARD + description: 'Speed with which payouts for this account are processed. Permitted + values: `STANDARD`, `SAME_DAY`.' + enum: + - SAME_DAY + - STANDARD + type: string required: - accountCode - accountHolderCode @@ -1220,6 +1242,7 @@ components: resultCode: resultCode merchantReference: merchantReference pspReference: pspReference + payoutSpeed: STANDARD properties: bankAccountUUID: description: The unique ID of the Bank Account to which the payout was made. @@ -1234,15 +1257,21 @@ components: description: The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions. type: string + payoutSpeed: + default: STANDARD + description: 'Speed with which payouts for this account are processed. Permitted + values: `STANDARD`, `SAME_DAY`.' + enum: + - SAME_DAY + - STANDARD + type: string pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: description: The result code. type: string - required: - - pspReference RefundFundsTransferRequest: example: originalReference: originalReference @@ -1300,14 +1329,12 @@ components: description: A PSP reference of the original fund transfer. type: string pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: description: The result code. type: string - required: - - pspReference RefundNotPaidOutTransfersRequest: example: accountCode: accountCode @@ -1348,14 +1375,12 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: description: The result code. type: string - required: - - pspReference SetupBeneficiaryRequest: example: sourceAccountCode: sourceAccountCode @@ -1374,7 +1399,6 @@ components: type: string required: - destinationAccountCode - - merchantReference - sourceAccountCode SetupBeneficiaryResponse: example: @@ -1401,14 +1425,12 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: description: The result code. type: string - required: - - pspReference Transaction: example: captureMerchantReference: captureMerchantReference @@ -1502,18 +1524,22 @@ components: transactionStatus: description: |- The status of the transaction. - >Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`. + >Permitted values: `PendingCredit`, `CreditFailed`, `CreditClosed`, `CreditSuspended`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`. enum: - Chargeback - ChargebackCorrection - ChargebackCorrectionReceived - ChargebackReceived - ChargebackReversed + - ChargebackReversedCorrection + - ChargebackReversedCorrectionReceived - ChargebackReversedReceived - Converted + - CreditClosed - CreditFailed - CreditReversed - CreditReversedReceived + - CreditSuspended - Credited - DebitFailed - DebitReversedReceived @@ -1523,6 +1549,8 @@ components: - FundTransfer - FundTransferReversed - ManualCorrected + - ManualCorrectionCredited + - ManualCorrectionDebited - Payout - PayoutReversed - PendingCredit @@ -1617,13 +1645,19 @@ components: transfer; may be used to link multiple transactions. type: string pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: description: The result code. type: string - required: - - pspReference + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http x-groups: - General diff --git a/src/platformsfund/api_default.go b/src/platformsfund/api_default.go index 60c4e646f..302cbfaec 100644 --- a/src/platformsfund/api_default.go +++ b/src/platformsfund/api_default.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,99 +14,99 @@ import ( _context "context" _nethttp "net/http" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // PlatformsFund PlatformsFund service type PlatformsFund common.Service /* -AccountHolderBalancePost Retrieve the balance(s) of an account holder. +PostAccountHolderBalance Retrieve the balance(s) of an account holder. This endpoint is used to retrieve the balance(s) of the accounts of an account holder. An account's balances are on a per-currency basis (i.e., an account may have multiple balances: one per currency). - * @param request AccountHolderBalanceRequest - reference of AccountHolderBalanceRequest). + * @param request AccountHolderBalanceRequest - reference of AccountHolderBalanceRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return AccountHolderBalanceResponse */ func (a PlatformsFund) AccountHolderBalance(req *AccountHolderBalanceRequest, ctxs ..._context.Context) (AccountHolderBalanceResponse, *_nethttp.Response, error) { - res := &AccountHolderBalanceResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/accountHolderBalance", ctxs...) - return *res, httpRes, err + res := &AccountHolderBalanceResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/accountHolderBalance", ctxs...) + return *res, httpRes, err } /* -AccountHolderTransactionListPost Retrieve a list of transactions. +PostAccountHolderTransactionList Retrieve a list of transactions. This endpoint is used to retrieve a list of Transactions for an account holder's accounts. The accounts and Transaction Statuses to be included on the list can be specified. Each call will return a maximum of fifty (50) Transactions per account; in order to retrieve the following set of Transactions another call should be made with the 'page' value incremented. Note that Transactions are ordered with most recent first. - * @param request AccountHolderTransactionListRequest - reference of AccountHolderTransactionListRequest). + * @param request AccountHolderTransactionListRequest - reference of AccountHolderTransactionListRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return AccountHolderTransactionListResponse */ func (a PlatformsFund) AccountHolderTransactionList(req *AccountHolderTransactionListRequest, ctxs ..._context.Context) (AccountHolderTransactionListResponse, *_nethttp.Response, error) { - res := &AccountHolderTransactionListResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/accountHolderTransactionList", ctxs...) - return *res, httpRes, err + res := &AccountHolderTransactionListResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/accountHolderTransactionList", ctxs...) + return *res, httpRes, err } /* -PayoutAccountHolderPost Disburse a specified amount from an account to the account holder. +PostPayoutAccountHolder Disburse a specified amount from an account to the account holder. This endpoint is used to pay out a specified amount from an account to the bank account of the account's account holder. - * @param request PayoutAccountHolderRequest - reference of PayoutAccountHolderRequest). + * @param request PayoutAccountHolderRequest - reference of PayoutAccountHolderRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return PayoutAccountHolderResponse */ func (a PlatformsFund) PayoutAccountHolder(req *PayoutAccountHolderRequest, ctxs ..._context.Context) (PayoutAccountHolderResponse, *_nethttp.Response, error) { - res := &PayoutAccountHolderResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/payoutAccountHolder", ctxs...) - return *res, httpRes, err + res := &PayoutAccountHolderResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/payoutAccountHolder", ctxs...) + return *res, httpRes, err } /* -RefundFundsTransferPost Make a refund of the existing transfer funds transfer. -This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders. - * @param request RefundFundsTransferRequest - reference of RefundFundsTransferRequest). +PostRefundFundsTransfer Make a refund of the existing transfer funds transfer. +This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders. + * @param request RefundFundsTransferRequest - reference of RefundFundsTransferRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return RefundFundsTransferResponse */ func (a PlatformsFund) RefundFundsTransfer(req *RefundFundsTransferRequest, ctxs ..._context.Context) (RefundFundsTransferResponse, *_nethttp.Response, error) { - res := &RefundFundsTransferResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/refundFundsTransfer", ctxs...) - return *res, httpRes, err + res := &RefundFundsTransferResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/refundFundsTransfer", ctxs...) + return *res, httpRes, err } /* -RefundNotPaidOutTransfersPost Refund all transactions of an account since the most recent payout. +PostRefundNotPaidOutTransfers Refund all transactions of an account since the most recent payout. This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a per-account basis (as opposed to a per-payment basis), so only the portion of the payment which was made to the specified account will be refunded. The commission(s), fee(s), and payment(s) to other account(s), will remain in the accounts to which they were sent as designated by the original payment's split details. - * @param request RefundNotPaidOutTransfersRequest - reference of RefundNotPaidOutTransfersRequest). + * @param request RefundNotPaidOutTransfersRequest - reference of RefundNotPaidOutTransfersRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return RefundNotPaidOutTransfersResponse */ func (a PlatformsFund) RefundNotPaidOutTransfers(req *RefundNotPaidOutTransfersRequest, ctxs ..._context.Context) (RefundNotPaidOutTransfersResponse, *_nethttp.Response, error) { - res := &RefundNotPaidOutTransfersResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/refundNotPaidOutTransfers", ctxs...) - return *res, httpRes, err + res := &RefundNotPaidOutTransfersResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/refundNotPaidOutTransfers", ctxs...) + return *res, httpRes, err } /* -SetupBeneficiaryPost Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary. +PostSetupBeneficiary Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary. This endpoint is used to define a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. Note that a series of benefactor/beneficiaries may not exceed four (4) beneficiaries and may not have a cycle in it. - * @param request SetupBeneficiaryRequest - reference of SetupBeneficiaryRequest). + * @param request SetupBeneficiaryRequest - reference of SetupBeneficiaryRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return SetupBeneficiaryResponse */ func (a PlatformsFund) SetupBeneficiary(req *SetupBeneficiaryRequest, ctxs ..._context.Context) (SetupBeneficiaryResponse, *_nethttp.Response, error) { - res := &SetupBeneficiaryResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/setupBeneficiary", ctxs...) - return *res, httpRes, err + res := &SetupBeneficiaryResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/setupBeneficiary", ctxs...) + return *res, httpRes, err } /* -TransferFundsPost Transfer funds from one platform account to another. +PostTransferFunds Transfer funds from one platform account to another. This endpoint is used to transfer funds from one account to another account. Both accounts must be in the same marketplace, but can have different account holders. The transfer must include a transfer code, which should be determined by the marketplace, in compliance with local regulations. - * @param request TransferFundsRequest - reference of TransferFundsRequest). + * @param request TransferFundsRequest - reference of TransferFundsRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return TransferFundsResponse */ func (a PlatformsFund) TransferFunds(req *TransferFundsRequest, ctxs ..._context.Context) (TransferFundsResponse, *_nethttp.Response, error) { - res := &TransferFundsResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/transferFunds", ctxs...) - return *res, httpRes, err + res := &TransferFundsResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/transferFunds", ctxs...) + return *res, httpRes, err } diff --git a/src/platformsfund/model_account_detail_balance.go b/src/platformsfund/model_account_detail_balance.go index c6ce93ddc..230299c7b 100644 --- a/src/platformsfund/model_account_detail_balance.go +++ b/src/platformsfund/model_account_detail_balance.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/model_account_holder_balance_request.go b/src/platformsfund/model_account_holder_balance_request.go index 8c0ee5096..f3c2e653e 100644 --- a/src/platformsfund/model_account_holder_balance_request.go +++ b/src/platformsfund/model_account_holder_balance_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/model_account_holder_balance_response.go b/src/platformsfund/model_account_holder_balance_response.go index de33a4fcf..fdc3eb39c 100644 --- a/src/platformsfund/model_account_holder_balance_response.go +++ b/src/platformsfund/model_account_holder_balance_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,8 +15,8 @@ type AccountHolderBalanceResponse struct { BalancePerAccount *[]AccountDetailBalance `json:"balancePerAccount,omitempty"` // 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"` + // 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"` TotalBalance *DetailBalance `json:"totalBalance,omitempty"` diff --git a/src/platformsfund/model_account_holder_transaction_list_request.go b/src/platformsfund/model_account_holder_transaction_list_request.go index c298a5dd7..3a5004549 100644 --- a/src/platformsfund/model_account_holder_transaction_list_request.go +++ b/src/platformsfund/model_account_holder_transaction_list_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,6 +15,6 @@ type AccountHolderTransactionListRequest struct { AccountHolderCode string `json:"accountHolderCode"` // A list of accounts to include in the transaction list. If left blank, the last fifty (50) transactions for all accounts of the account holder will be included. TransactionListsPerAccount *[]TransactionListForAccount `json:"transactionListsPerAccount,omitempty"` - // A list of statuses to include in the transaction list. If left blank, all transactions will be included. >Permitted values: >* `PendingCredit` - a pending balance credit. >* `CreditFailed` - a pending credit failure; the balance will not be credited. >* `Credited` - a credited balance. >* `PendingDebit` - a pending balance debit (e.g., a refund). >* `DebitFailed` - a pending debit failure; the balance will not be debited. >* `Debited` - a debited balance (e.g., a refund). >* `DebitReversedReceived` - a pending refund reversal. >* `DebitedReversed` - a reversed refund. >* `ChargebackReceived` - a received chargeback request. >* `Chargeback` - a processed chargeback. >* `ChargebackReversedReceived` - a pending chargeback reversal. >* `ChargebackReversed` - a reversed chargeback. >* `Converted` - converted. >* `ManualCorrected` - manual booking/adjustment by Adyen. >* `Payout` - a payout. >* `PayoutReversed` - a reversed payout. >* `PendingFundTransfer` - a pending transfer of funds from one account to another. >* `FundTransfer` - a transfer of funds from one account to another. + // A list of statuses to include in the transaction list. If left blank, all transactions will be included. >Permitted values: >* `PendingCredit` - a pending balance credit. >* `CreditFailed` - a pending credit failure; the balance will not be credited. >* `Credited` - a credited balance. >* `PendingDebit` - a pending balance debit (e.g., a refund). >* `CreditClosed` - a pending credit closed; the balance will not be credited. >* `CreditSuspended` - a pending credit closed; the balance will not be credited. >* `DebitFailed` - a pending debit failure; the balance will not be debited. >* `Debited` - a debited balance (e.g., a refund). >* `DebitReversedReceived` - a pending refund reversal. >* `DebitedReversed` - a reversed refund. >* `ChargebackReceived` - a received chargeback request. >* `Chargeback` - a processed chargeback. >* `ChargebackReversedReceived` - a pending chargeback reversal. >* `ChargebackReversed` - a reversed chargeback. >* `Converted` - converted. >* `ManualCorrected` - manual booking/adjustment by Adyen. >* `Payout` - a payout. >* `PayoutReversed` - a reversed payout. >* `PendingFundTransfer` - a pending transfer of funds from one account to another. >* `FundTransfer` - a transfer of funds from one account to another. TransactionStatuses []string `json:"transactionStatuses,omitempty"` } diff --git a/src/platformsfund/model_account_holder_transaction_list_response.go b/src/platformsfund/model_account_holder_transaction_list_response.go index 4291fde12..6bf2a117a 100644 --- a/src/platformsfund/model_account_holder_transaction_list_response.go +++ b/src/platformsfund/model_account_holder_transaction_list_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,8 +15,8 @@ type AccountHolderTransactionListResponse struct { AccountTransactionLists *[]AccountTransactionList `json:"accountTransactionLists,omitempty"` // 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"` + // 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"` } diff --git a/src/platformsfund/model_account_transaction_list.go b/src/platformsfund/model_account_transaction_list.go index 518c3639c..06345148f 100644 --- a/src/platformsfund/model_account_transaction_list.go +++ b/src/platformsfund/model_account_transaction_list.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/model_amount.go b/src/platformsfund/model_amount.go index 8014623b6..e8a0ebf94 100644 --- a/src/platformsfund/model_amount.go +++ b/src/platformsfund/model_amount.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,6 +13,6 @@ package platformsfund type Amount struct { // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). Currency string `json:"currency"` - // The payable amount that can be charged for the transaction. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + // The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). Value int64 `json:"value"` } diff --git a/src/platformsfund/model_bank_account_detail.go b/src/platformsfund/model_bank_account_detail.go index 951528c04..0aad4f4aa 100644 --- a/src/platformsfund/model_bank_account_detail.go +++ b/src/platformsfund/model_bank_account_detail.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -11,9 +11,9 @@ package platformsfund // BankAccountDetail struct for BankAccountDetail type BankAccountDetail struct { - // The bank account number (without separators). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The bank account number (without separators). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. AccountNumber string `json:"accountNumber,omitempty"` - // The type of bank account. Only applicable to bank accounts held in the USA. The permitted values are: `checking`, `savings`. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The type of bank account. Only applicable to bank accounts held in the USA. The permitted values are: `checking`, `savings`. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. AccountType string `json:"accountType,omitempty"` // The name of the bank account. BankAccountName string `json:"bankAccountName,omitempty"` @@ -21,46 +21,46 @@ type BankAccountDetail struct { BankAccountReference string `json:"bankAccountReference,omitempty"` // The unique identifier (UUID) of the Bank Account. >If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID. >If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue. >If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail. >If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated. BankAccountUUID string `json:"bankAccountUUID,omitempty"` - // The bank identifier code. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The bank identifier code. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. BankBicSwift string `json:"bankBicSwift,omitempty"` - // The city in which the bank branch is located. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The city in which the bank branch is located. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. BankCity string `json:"bankCity,omitempty"` - // The bank code of the banking institution with which the bank account is registered. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The bank code of the banking institution with which the bank account is registered. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. BankCode string `json:"bankCode,omitempty"` - // The name of the banking institution with which the bank account is held. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The name of the banking institution with which the bank account is held. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. BankName string `json:"bankName,omitempty"` - // The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account: * United States - Routing number * United Kingdom - Sort code * Germany - Bankleitzahl >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account: * United States - Routing number * United Kingdom - Sort code * Germany - Bankleitzahl >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. BranchCode string `json:"branchCode,omitempty"` - // The check code of the bank account. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The check code of the bank account. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. CheckCode string `json:"checkCode,omitempty"` - // The two-letter country code in which the bank account is registered. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The two-letter country code in which the bank account is registered. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. CountryCode string `json:"countryCode,omitempty"` - // The currency in which the bank account deals. >The permitted currency codes are defined in ISO-4217 (e.g. 'EUR'). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The currency in which the bank account deals. >The permitted currency codes are defined in ISO-4217 (e.g. 'EUR'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. CurrencyCode string `json:"currencyCode,omitempty"` - // The international bank account number. >The IBAN standard is defined in ISO-13616. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The international bank account number. >The IBAN standard is defined in ISO-13616. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. Iban string `json:"iban,omitempty"` - // The city of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The city of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerCity string `json:"ownerCity,omitempty"` - // The country code of the country of residence of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The country code of the country of residence of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerCountryCode string `json:"ownerCountryCode,omitempty"` // The date of birth of the bank account owner. OwnerDateOfBirth string `json:"ownerDateOfBirth,omitempty"` - // The house name or number of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The house name or number of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerHouseNumberOrName string `json:"ownerHouseNumberOrName,omitempty"` - // The name of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The name of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerName string `json:"ownerName,omitempty"` - // The country code of the country of nationality of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The country code of the country of nationality of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerNationality string `json:"ownerNationality,omitempty"` - // The postal code of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The postal code of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerPostalCode string `json:"ownerPostalCode,omitempty"` - // The state of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The state of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerState string `json:"ownerState,omitempty"` - // The street name of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The street name of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. OwnerStreet string `json:"ownerStreet,omitempty"` // If set to true, the bank account is a primary account. PrimaryAccount bool `json:"primaryAccount,omitempty"` - // The tax ID number. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The tax ID number. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. TaxId string `json:"taxId,omitempty"` - // The URL to be used for bank account verification. This may be generated on bank account creation. >Refer to the [Onboarding and verification](https://docs.adyen.com/marketpay/onboarding-and-verification) section for details on field requirements. + // The URL to be used for bank account verification. This may be generated on bank account creation. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. UrlForVerification string `json:"urlForVerification,omitempty"` } diff --git a/src/platformsfund/model_detail_balance.go b/src/platformsfund/model_detail_balance.go index b6914b924..e7ed66f9c 100644 --- a/src/platformsfund/model_detail_balance.go +++ b/src/platformsfund/model_detail_balance.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/model_error_field_type.go b/src/platformsfund/model_error_field_type.go index 39fc470d9..22a92db42 100644 --- a/src/platformsfund/model_error_field_type.go +++ b/src/platformsfund/model_error_field_type.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/model_field_type.go b/src/platformsfund/model_field_type.go index ec88d5c7d..7f4d7a92a 100644 --- a/src/platformsfund/model_field_type.go +++ b/src/platformsfund/model_field_type.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/model_payout_account_holder_request.go b/src/platformsfund/model_payout_account_holder_request.go index 06d765d9d..01be13287 100644 --- a/src/platformsfund/model_payout_account_holder_request.go +++ b/src/platformsfund/model_payout_account_holder_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -24,4 +24,6 @@ type PayoutAccountHolderRequest struct { MerchantReference string `json:"merchantReference,omitempty"` // The unique ID of the payout method held by the Account Holder to which the payout is to be made. If left blank, a payout instrument is automatically selected. PayoutMethodCode string `json:"payoutMethodCode,omitempty"` + // Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + PayoutSpeed string `json:"payoutSpeed,omitempty"` } diff --git a/src/platformsfund/model_payout_account_holder_response.go b/src/platformsfund/model_payout_account_holder_response.go index e505f6e37..112897045 100644 --- a/src/platformsfund/model_payout_account_holder_response.go +++ b/src/platformsfund/model_payout_account_holder_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -17,8 +17,10 @@ type PayoutAccountHolderResponse struct { InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` // The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions. MerchantReference string `json:"merchantReference,omitempty"` - // The reference of a request. Can be used to uniquely identify the request. - PspReference string `json:"pspReference"` + // Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + PayoutSpeed string `json:"payoutSpeed,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"` } diff --git a/src/platformsfund/model_refund_funds_transfer_request.go b/src/platformsfund/model_refund_funds_transfer_request.go index 66cc36623..88ce93390 100644 --- a/src/platformsfund/model_refund_funds_transfer_request.go +++ b/src/platformsfund/model_refund_funds_transfer_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/model_refund_funds_transfer_response.go b/src/platformsfund/model_refund_funds_transfer_response.go index 891905510..cad778f75 100644 --- a/src/platformsfund/model_refund_funds_transfer_response.go +++ b/src/platformsfund/model_refund_funds_transfer_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -18,8 +18,8 @@ type RefundFundsTransferResponse struct { Message string `json:"message,omitempty"` // A PSP reference of the original fund transfer. OriginalReference string `json:"originalReference,omitempty"` - // The reference of a request. Can be used to uniquely identify the request. - PspReference string `json:"pspReference"` + // 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"` } diff --git a/src/platformsfund/model_refund_not_paid_out_transfers_request.go b/src/platformsfund/model_refund_not_paid_out_transfers_request.go index 6f3d53410..a8c2b2f12 100644 --- a/src/platformsfund/model_refund_not_paid_out_transfers_request.go +++ b/src/platformsfund/model_refund_not_paid_out_transfers_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/model_refund_not_paid_out_transfers_response.go b/src/platformsfund/model_refund_not_paid_out_transfers_response.go index b79a67697..8b19b99c7 100644 --- a/src/platformsfund/model_refund_not_paid_out_transfers_response.go +++ b/src/platformsfund/model_refund_not_paid_out_transfers_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,8 +13,8 @@ package platformsfund type RefundNotPaidOutTransfersResponse 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"` + // 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"` } diff --git a/src/platformsfund/model_setup_beneficiary_request.go b/src/platformsfund/model_setup_beneficiary_request.go index 231553863..a53395804 100644 --- a/src/platformsfund/model_setup_beneficiary_request.go +++ b/src/platformsfund/model_setup_beneficiary_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,7 +14,7 @@ type SetupBeneficiaryRequest struct { // The destination account code. DestinationAccountCode string `json:"destinationAccountCode"` // A value that can be supplied at the discretion of the executing user. - MerchantReference string `json:"merchantReference"` + MerchantReference string `json:"merchantReference,omitempty"` // The benefactor account. SourceAccountCode string `json:"sourceAccountCode"` } diff --git a/src/platformsfund/model_setup_beneficiary_response.go b/src/platformsfund/model_setup_beneficiary_response.go index fc54cb543..b37c375be 100644 --- a/src/platformsfund/model_setup_beneficiary_response.go +++ b/src/platformsfund/model_setup_beneficiary_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,8 +13,8 @@ package platformsfund type SetupBeneficiaryResponse 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"` + // 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"` } diff --git a/src/platformsfund/model_transaction.go b/src/platformsfund/model_transaction.go index 61b2b0c44..a3bfcc61a 100644 --- a/src/platformsfund/model_transaction.go +++ b/src/platformsfund/model_transaction.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -40,7 +40,7 @@ type Transaction struct { PspReference string `json:"pspReference,omitempty"` // The code of the account from which funds were debited during an incoming fund transfer. SourceAccountCode string `json:"sourceAccountCode,omitempty"` - // The status of the transaction. >Permitted values: `PendingCredit`, `CreditFailed`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`. + // The status of the transaction. >Permitted values: `PendingCredit`, `CreditFailed`, `CreditClosed`, `CreditSuspended`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`. TransactionStatus string `json:"transactionStatus,omitempty"` // The transfer code of the transaction. TransferCode string `json:"transferCode,omitempty"` diff --git a/src/platformsfund/model_transaction_list_for_account.go b/src/platformsfund/model_transaction_list_for_account.go index 976468c34..e446315e8 100644 --- a/src/platformsfund/model_transaction_list_for_account.go +++ b/src/platformsfund/model_transaction_list_for_account.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/model_transfer_funds_request.go b/src/platformsfund/model_transfer_funds_request.go index 2b8a7195b..cd239965a 100644 --- a/src/platformsfund/model_transfer_funds_request.go +++ b/src/platformsfund/model_transfer_funds_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsfund/model_transfer_funds_response.go b/src/platformsfund/model_transfer_funds_response.go index 69b89edb2..8fea4367f 100644 --- a/src/platformsfund/model_transfer_funds_response.go +++ b/src/platformsfund/model_transfer_funds_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Fund API * - * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/marketpay). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v5/accountHolderBalance ``` + * The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Fund 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/Fund/v6/accountHolderBalance ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,8 +15,8 @@ type TransferFundsResponse struct { InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` // The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions. MerchantReference string `json:"merchantReference,omitempty"` - // The reference of a request. Can be used to uniquely identify the request. - PspReference string `json:"pspReference"` + // 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"` } diff --git a/src/platformshostedonboardingpage/.openapi-generator/VERSION b/src/platformshostedonboardingpage/.openapi-generator/VERSION index ecedc98d1..b5d898602 100644 --- a/src/platformshostedonboardingpage/.openapi-generator/VERSION +++ b/src/platformshostedonboardingpage/.openapi-generator/VERSION @@ -1 +1 @@ -4.3.1 \ No newline at end of file +4.3.1-SNAPSHOT \ No newline at end of file diff --git a/src/platformshostedonboardingpage/README.md b/src/platformshostedonboardingpage/README.md index d4feacdb8..d8572cbad 100644 --- a/src/platformshostedonboardingpage/README.md +++ b/src/platformshostedonboardingpage/README.md @@ -1,7 +1,7 @@ # Go API client for platformshostedonboardingpage -The Hosted Onboarding Page (HOP) API provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. -For more information, refer to our [documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/hosted-onboarding-page). +Hosted Onboarding provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. +For more information, refer to our [documentation](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: @@ -18,13 +18,13 @@ The HOP API supports versioning of its endpoints through a version suffix in the For example: ``` -https://cal-test.adyen.com/cal/services/Hop/v1/getOnboardingUrl +https://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl ``` ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 1 +- API version: 6 - Package version: 1.0.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit [https://support.adyen.com/](https://support.adyen.com/) diff --git a/src/platformshostedonboardingpage/api/openapi.yaml b/src/platformshostedonboardingpage/api/openapi.yaml index 9010a4c8e..f57e7ea37 100644 --- a/src/platformshostedonboardingpage/api/openapi.yaml +++ b/src/platformshostedonboardingpage/api/openapi.yaml @@ -1,12 +1,12 @@ -openapi: 3.0.0 +openapi: 3.0.3 info: contact: email: support@adyen.com name: Adyen Support url: https://support.adyen.com/ - description: "The Hosted Onboarding Page (HOP) API provides endpoints for using\ - \ the Hosted Onboarding Page. The related entities include account holders only.\ - \ \nFor more information, refer to our [documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/hosted-onboarding-page).\n\ + description: "Hosted Onboarding provides endpoints for using the Hosted Onboarding\ + \ Page. The related entities include account holders only. \nFor more information,\ + \ refer to our [documentation](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page).\n\ ## Authentication\nTo connect to the HOP API, you must use basic authentication\ \ credentials of your web service user. If you don't have one, please contact\ \ the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then\ @@ -16,20 +16,20 @@ info: \ new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\ \n## Versioning\nThe HOP 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.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v1/getOnboardingUrl\n\ + \ XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl\n\ ```" termsOfService: https://www.adyen.com/legal/terms-and-conditions - title: 'Adyen for Platforms: Hosted Onboarding Page API' - version: "1" + title: 'Adyen for Platforms: Hosted Onboarding' + version: "6" servers: -- url: https://cal-test.adyen.com/cal/services/Hop/v1 +- url: https://cal-test.adyen.com/cal/services/Hop/v6 paths: /getOnboardingUrl: post: - description: This endpoint is used to get a new onboarding url for a specific - account holder. Each account holder represents a single sub-merchant, and - each sub-merchant must be represented by an account holder. A returnUrl can - also be specified as part of this request. + description: "Returns a link to a Hosted Onboarding Page (HOP) to be used by\ + \ a specific account holder. Each account holder represents a single sub-merchant.\n\ + \nFor more information on how to use HOP, refer to [Hosted Onboarding Page](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page). " + operationId: post-getOnboardingUrl requestBody: content: application/json: @@ -44,15 +44,15 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. - summary: Get a new onboarding url for an account holder. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. + summary: Get a link to a Hosted Onboarding Page. x-groupName: Hosted Onboarding Page x-sortIndex: 1 components: @@ -130,6 +130,7 @@ components: - drivingLicense - email - firstName + - formType - fullPhoneNumber - gender - hopWebserviceUser @@ -177,6 +178,9 @@ components: - sourceAccountCode - stateOrProvince - status + - stockExchange + - stockNumber + - stockTicker - store - storeDetail - storeName @@ -191,6 +195,7 @@ components: - virtualAccount - visaNumber - webAddress + - year type: string shareholderCode: description: The code of the shareholder that the field belongs to. If empty, @@ -199,6 +204,8 @@ components: GetOnboardingUrlRequest: example: accountHolderCode: accountHolderCode + editMode: true + shopperLocale: shopperLocale platformName: platformName returnUrl: returnUrl properties: @@ -206,6 +213,10 @@ components: description: The account holder code you provided when you created the account holder. type: string + editMode: + description: Indicates if editing checks is allowed even if all the checks + have passed. + type: boolean platformName: description: The platform name which will show up in the welcome page. type: string @@ -216,11 +227,18 @@ components: redirected back to the default return URL configured in your platform account. type: string + shopperLocale: + description: "The language to be used in the page, specified by a combination\ + \ of a language and country code. For example, **pt-BR**. \n\nIf not specified\ + \ in the request or if the language is not supported, the page uses the\ + \ browser language. If the browser language is not supported, the page\ + \ uses **en-US** by default.\n\nFor a list supported languages, refer\ + \ to [Change the page language](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page#change-page-language)." + type: string required: - accountHolderCode GetOnboardingUrlResponse: example: - submittedAsync: true redirectUrl: redirectUrl invalidFields: - errorDescription: errorDescription @@ -245,26 +263,24 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string redirectUrl: description: The URL to the Hosted Onboarding Page where you should redirect - your sub-merchant. This URL must be used within 15 seconds and can only + your sub-merchant. This URL must be used within 30 seconds and can only be used once. type: string resultCode: description: The result code. type: string - submittedAsync: - description: |- - Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied: - * **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable. - * **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received. - * **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue. - type: boolean - required: - - pspReference - - submittedAsync + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http x-groups: - Hosted Onboarding Page diff --git a/src/platformshostedonboardingpage/api_default.go b/src/platformshostedonboardingpage/api_default.go index fe86ff34e..d8e94e4b6 100644 --- a/src/platformshostedonboardingpage/api_default.go +++ b/src/platformshostedonboardingpage/api_default.go @@ -1,9 +1,9 @@ /* - * Adyen for Platforms: Hosted Onboarding Page API + * Adyen for Platforms: Hosted Onboarding * - * The Hosted Onboarding Page (HOP) API provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our [documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The HOP 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/Hop/v1/getOnboardingUrl ``` + * Hosted Onboarding provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our [documentation](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The HOP 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/Hop/v6/getOnboardingUrl ``` * - * API version: 1 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,21 +14,21 @@ import ( _context "context" _nethttp "net/http" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // PlatformsHostedOnboardingPage PlatformsHostedOnboardingPage service type PlatformsHostedOnboardingPage common.Service /* -GetOnboardingUrlPost Get a new onboarding url for an account holder. -This endpoint is used to get a new onboarding url for a specific account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. A returnUrl can also be specified as part of this request. - * @param request GetOnboardingUrlRequest - reference of GetOnboardingUrlRequest). +PostGetOnboardingUrl Get a link to a Hosted Onboarding Page. +Returns a link to a Hosted Onboarding Page (HOP) to be used by a specific account holder. Each account holder represents a single sub-merchant. For more information on how to use HOP, refer to [Hosted Onboarding Page](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page). + * @param request GetOnboardingUrlRequest - reference of GetOnboardingUrlRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return GetOnboardingUrlResponse */ -func (a PlatformsHostedOnboardingPage) GetOnboardingUrlPost(req *GetOnboardingUrlRequest, ctxs ..._context.Context) (GetOnboardingUrlResponse, *_nethttp.Response, error) { - res := &GetOnboardingUrlResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/getOnboardingUrl", ctxs...) - return *res, httpRes, err +func (a PlatformsHostedOnboardingPage) GetOnboardingUrl(req *GetOnboardingUrlRequest, ctxs ..._context.Context) (GetOnboardingUrlResponse, *_nethttp.Response, error) { + res := &GetOnboardingUrlResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/getOnboardingUrl", ctxs...) + return *res, httpRes, err } diff --git a/src/platformshostedonboardingpage/model_error_field_type.go b/src/platformshostedonboardingpage/model_error_field_type.go index 29c95c92d..c9ec9b2a3 100644 --- a/src/platformshostedonboardingpage/model_error_field_type.go +++ b/src/platformshostedonboardingpage/model_error_field_type.go @@ -1,9 +1,9 @@ /* - * Adyen for Platforms: Hosted Onboarding Page API + * Adyen for Platforms: Hosted Onboarding * - * The Hosted Onboarding Page (HOP) API provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our [documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The HOP 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/Hop/v1/getOnboardingUrl ``` + * Hosted Onboarding provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our [documentation](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The HOP 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/Hop/v6/getOnboardingUrl ``` * - * API version: 1 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformshostedonboardingpage/model_field_type.go b/src/platformshostedonboardingpage/model_field_type.go index f1a7cc284..ad3575371 100644 --- a/src/platformshostedonboardingpage/model_field_type.go +++ b/src/platformshostedonboardingpage/model_field_type.go @@ -1,9 +1,9 @@ /* - * Adyen for Platforms: Hosted Onboarding Page API + * Adyen for Platforms: Hosted Onboarding * - * The Hosted Onboarding Page (HOP) API provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our [documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The HOP 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/Hop/v1/getOnboardingUrl ``` + * Hosted Onboarding provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our [documentation](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The HOP 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/Hop/v6/getOnboardingUrl ``` * - * API version: 1 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformshostedonboardingpage/model_get_onboarding_url_request.go b/src/platformshostedonboardingpage/model_get_onboarding_url_request.go index 3f0135545..0aa1025eb 100644 --- a/src/platformshostedonboardingpage/model_get_onboarding_url_request.go +++ b/src/platformshostedonboardingpage/model_get_onboarding_url_request.go @@ -1,9 +1,9 @@ /* - * Adyen for Platforms: Hosted Onboarding Page API + * Adyen for Platforms: Hosted Onboarding * - * The Hosted Onboarding Page (HOP) API provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our [documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The HOP 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/Hop/v1/getOnboardingUrl ``` + * Hosted Onboarding provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our [documentation](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The HOP 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/Hop/v6/getOnboardingUrl ``` * - * API version: 1 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,8 +13,12 @@ package platformshostedonboardingpage type GetOnboardingUrlRequest struct { // The account holder code you provided when you created the account holder. AccountHolderCode string `json:"accountHolderCode"` + // Indicates if editing checks is allowed even if all the checks have passed. + EditMode bool `json:"editMode,omitempty"` // The platform name which will show up in the welcome page. PlatformName string `json:"platformName,omitempty"` // The URL where the sub-merchant will be redirected back to after they complete the onboarding, or if their session times out. Maximum length of 500 characters. If you don't provide this, the sub-merchant will be redirected back to the default return URL configured in your platform account. ReturnUrl string `json:"returnUrl,omitempty"` + // The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. If not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default. For a list supported languages, refer to [Change the page language](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page#change-page-language). + ShopperLocale string `json:"shopperLocale,omitempty"` } diff --git a/src/platformshostedonboardingpage/model_get_onboarding_url_response.go b/src/platformshostedonboardingpage/model_get_onboarding_url_response.go index ec6ea40be..ea2867130 100644 --- a/src/platformshostedonboardingpage/model_get_onboarding_url_response.go +++ b/src/platformshostedonboardingpage/model_get_onboarding_url_response.go @@ -1,9 +1,9 @@ /* - * Adyen for Platforms: Hosted Onboarding Page API + * Adyen for Platforms: Hosted Onboarding * - * The Hosted Onboarding Page (HOP) API provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our [documentation](https://docs.adyen.com/marketpay/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The HOP 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/Hop/v1/getOnboardingUrl ``` + * Hosted Onboarding provides endpoints for using the Hosted Onboarding Page. The related entities include account holders only. For more information, refer to our [documentation](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page). ## Authentication To connect to the HOP API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The HOP 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/Hop/v6/getOnboardingUrl ``` * - * API version: 1 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,12 +13,10 @@ package platformshostedonboardingpage type GetOnboardingUrlResponse 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"` - // The URL to the Hosted Onboarding Page where you should redirect your sub-merchant. This URL must be used within 15 seconds and can only be used once. + // The reference of a request. Can be used to uniquely identify the request. + PspReference string `json:"pspReference,omitempty"` + // The URL to the Hosted Onboarding Page where you should redirect your sub-merchant. This URL must be used within 30 seconds and can only be used once. RedirectUrl string `json:"redirectUrl,omitempty"` // The result code. ResultCode string `json:"resultCode,omitempty"` - // Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied: * **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable. * **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received. * **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue. - SubmittedAsync bool `json:"submittedAsync"` } diff --git a/src/platformsnotificationconfiguration/.openapi-generator/VERSION b/src/platformsnotificationconfiguration/.openapi-generator/VERSION index ecedc98d1..b5d898602 100644 --- a/src/platformsnotificationconfiguration/.openapi-generator/VERSION +++ b/src/platformsnotificationconfiguration/.openapi-generator/VERSION @@ -1 +1 @@ -4.3.1 \ No newline at end of file +4.3.1-SNAPSHOT \ No newline at end of file diff --git a/src/platformsnotificationconfiguration/README.md b/src/platformsnotificationconfiguration/README.md index 27b02fcd2..750d38de0 100644 --- a/src/platformsnotificationconfiguration/README.md +++ b/src/platformsnotificationconfiguration/README.md @@ -2,9 +2,9 @@ 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](https://docs.adyen.com/marketpay/marketpay-notifications). +For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: +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](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl @@ -19,13 +19,13 @@ The Notification Configuration API supports versioning of its endpoints through For example: ``` -https://cal-test.adyen.com/cal/services/Notification/v1/createNotificationConfiguration +https://cal-test.adyen.com/cal/services/Notification/v6/createNotificationConfiguration ``` ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 5 +- API version: 6 - Package version: 1.0.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit [https://support.adyen.com/](https://support.adyen.com/) diff --git a/src/platformsnotificationconfiguration/api/openapi.yaml b/src/platformsnotificationconfiguration/api/openapi.yaml index 904b881e2..c852c89c7 100644 --- a/src/platformsnotificationconfiguration/api/openapi.yaml +++ b/src/platformsnotificationconfiguration/api/openapi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.0.3 info: contact: email: support@adyen.com @@ -7,9 +7,9 @@ info: description: |- 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](https://docs.adyen.com/marketpay/marketpay-notifications). + For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: + 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](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl @@ -24,13 +24,13 @@ info: For example: ``` - https://cal-test.adyen.com/cal/services/Notification/v1/createNotificationConfiguration + https://cal-test.adyen.com/cal/services/Notification/v6/createNotificationConfiguration ``` termsOfService: https://www.adyen.com/legal/terms-and-conditions title: 'Adyen for Platforms: Notification Configuration API' - version: "5" + version: "6" servers: -- url: https://cal-test.adyen.com/cal/services/Notification/v5 +- url: https://cal-test.adyen.com/cal/services/Notification/v6 paths: /createNotificationConfiguration: post: @@ -42,6 +42,7 @@ paths: 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. + operationId: post-createNotificationConfiguration requestBody: content: application/json: @@ -62,6 +63,7 @@ paths: description: 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. + operationId: post-deleteNotificationConfigurations requestBody: content: application/json: @@ -81,6 +83,7 @@ paths: post: description: This endpoint is used to retrieve the details of the configuration of a notification subscription. + operationId: post-getNotificationConfiguration requestBody: content: application/json: @@ -101,6 +104,7 @@ paths: description: This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user. + operationId: post-getNotificationConfigurationList requestBody: content: application/json: @@ -121,6 +125,7 @@ paths: description: 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. + operationId: post-testNotificationConfiguration requestBody: content: application/json: @@ -141,6 +146,7 @@ paths: description: 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. + operationId: post-updateNotificationConfiguration requestBody: content: application/json: @@ -278,6 +284,7 @@ components: - drivingLicense - email - firstName + - formType - fullPhoneNumber - gender - hopWebserviceUser @@ -325,6 +332,9 @@ components: - sourceAccountCode - stateOrProvince - status + - stockExchange + - stockNumber + - stockTicker - store - storeDetail - storeName @@ -339,6 +349,7 @@ components: - virtualAccount - visaNumber - webAddress + - year type: string shareholderCode: description: The code of the shareholder that the field belongs to. If empty, @@ -369,14 +380,12 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: description: The result code. type: string - required: - - pspReference GetNotificationConfigurationListResponse: example: invalidFields: @@ -436,7 +445,7 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -444,7 +453,6 @@ components: type: string required: - configurations - - pspReference GetNotificationConfigurationRequest: example: notificationId: 0 @@ -498,7 +506,7 @@ components: $ref: '#/components/schemas/ErrorFieldType' type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -506,7 +514,6 @@ components: type: string required: - configurationDetails - - pspReference NotificationConfigurationDetails: example: hmacSignatureKey: hmacSignatureKey @@ -532,9 +539,7 @@ components: format: int32 type: integer description: - description: |- - A description of the notification subscription configuration. - >Required when creating a configuration, forbidden when updating a configuration. + description: A description of the notification subscription configuration. type: string eventConfigs: description: The types of events whose notifications apply to this configuration. @@ -593,6 +598,7 @@ components: enum: - ACCOUNT_CLOSED - ACCOUNT_CREATED + - ACCOUNT_FUNDS_BELOW_THRESHOLD - ACCOUNT_HOLDER_CREATED - ACCOUNT_HOLDER_LIMIT_REACHED - ACCOUNT_HOLDER_PAYOUT @@ -606,10 +612,10 @@ components: - COMPENSATE_NEGATIVE_BALANCE - DIRECT_DEBIT_INITIATED - PAYMENT_FAILURE + - REFUND_FUNDS_TRANSFER - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS - - TRANSFER_FUNDS_REFUND type: string includeMode: description: |- @@ -639,6 +645,7 @@ components: enum: - ACCOUNT_CLOSED - ACCOUNT_CREATED + - ACCOUNT_FUNDS_BELOW_THRESHOLD - ACCOUNT_HOLDER_CREATED - ACCOUNT_HOLDER_LIMIT_REACHED - ACCOUNT_HOLDER_PAYOUT @@ -652,10 +659,10 @@ components: - COMPENSATE_NEGATIVE_BALANCE - DIRECT_DEBIT_INITIATED - PAYMENT_FAILURE + - REFUND_FUNDS_TRANSFER - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS - - TRANSFER_FUNDS_REFUND type: string type: array notificationId: @@ -711,6 +718,7 @@ components: enum: - ACCOUNT_CLOSED - ACCOUNT_CREATED + - ACCOUNT_FUNDS_BELOW_THRESHOLD - ACCOUNT_HOLDER_CREATED - ACCOUNT_HOLDER_LIMIT_REACHED - ACCOUNT_HOLDER_PAYOUT @@ -724,10 +732,10 @@ components: - COMPENSATE_NEGATIVE_BALANCE - DIRECT_DEBIT_INITIATED - PAYMENT_FAILURE + - REFUND_FUNDS_TRANSFER - REPORT_AVAILABLE - SCHEDULED_REFUNDS - TRANSFER_FUNDS - - TRANSFER_FUNDS_REFUND type: string type: array exchangeMessages: @@ -751,7 +759,7 @@ components: type: string type: array pspReference: - description: The reference of a request. Can be used to uniquely identify + description: The reference of a request. Can be used to uniquely identify the request. type: string resultCode: @@ -762,7 +770,6 @@ components: - exchangeMessages - notificationId - okMessages - - pspReference UpdateNotificationConfigurationRequest: example: configurationDetails: @@ -785,5 +792,13 @@ components: $ref: '#/components/schemas/NotificationConfigurationDetails' required: - configurationDetails + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http x-groups: - General diff --git a/src/platformsnotificationconfiguration/api_default.go b/src/platformsnotificationconfiguration/api_default.go index 1c98e02d4..f1d82a260 100644 --- a/src/platformsnotificationconfiguration/api_default.go +++ b/src/platformsnotificationconfiguration/api_default.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,86 +14,86 @@ import ( _context "context" _nethttp "net/http" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // PlatformsNotificationConfiguration PlatformsNotificationConfiguration service type PlatformsNotificationConfiguration common.Service /* -CreateNotificationConfigurationPost Subscribe to notifications. +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 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 (a PlatformsNotificationConfiguration) CreateNotificationConfiguration(req *CreateNotificationConfigurationRequest, ctxs ..._context.Context) (GetNotificationConfigurationResponse, *_nethttp.Response, error) { - res := &GetNotificationConfigurationResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/createNotificationConfiguration", ctxs...) - return *res, httpRes, err + res := &GetNotificationConfigurationResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/createNotificationConfiguration", ctxs...) + return *res, httpRes, err } /* -DeleteNotificationConfigurationsPost Delete an existing notification subscription configuration. +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 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 (a PlatformsNotificationConfiguration) DeleteNotificationConfigurations(req *DeleteNotificationConfigurationRequest, ctxs ..._context.Context) (GenericResponse, *_nethttp.Response, error) { - res := &GenericResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/deleteNotificationConfigurations", ctxs...) - return *res, httpRes, err + res := &GenericResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/deleteNotificationConfigurations", ctxs...) + return *res, httpRes, err } /* -GetNotificationConfigurationListPost 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{}). +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 GetNotificationConfigurationListResponse +@return GetNotificationConfigurationResponse */ -func (a PlatformsNotificationConfiguration) GetNotificationConfigurationList(req *interface{}, ctxs ..._context.Context) (GetNotificationConfigurationListResponse, *_nethttp.Response, error) { - res := &GetNotificationConfigurationListResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/getNotificationConfigurationList", ctxs...) - return *res, httpRes, err +func (a PlatformsNotificationConfiguration) GetNotificationConfiguration(req *GetNotificationConfigurationRequest, ctxs ..._context.Context) (GetNotificationConfigurationResponse, *_nethttp.Response, error) { + res := &GetNotificationConfigurationResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/getNotificationConfiguration", ctxs...) + return *res, httpRes, err } /* -GetNotificationConfigurationPost 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). +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 GetNotificationConfigurationResponse +@return GetNotificationConfigurationListResponse */ -func (a PlatformsNotificationConfiguration) GetNotificationConfiguration(req *GetNotificationConfigurationRequest, ctxs ..._context.Context) (GetNotificationConfigurationResponse, *_nethttp.Response, error) { - res := &GetNotificationConfigurationResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/getNotificationConfiguration", ctxs...) - return *res, httpRes, err +func (a PlatformsNotificationConfiguration) GetNotificationConfigurationList(req *interface{}, ctxs ..._context.Context) (GetNotificationConfigurationListResponse, *_nethttp.Response, error) { + res := &GetNotificationConfigurationListResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/getNotificationConfigurationList", ctxs...) + return *res, httpRes, err } /* -TestNotificationConfigurationPost Test an existing notification configuration. +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 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 (a PlatformsNotificationConfiguration) TestNotificationConfiguration(req *TestNotificationConfigurationRequest, ctxs ..._context.Context) (TestNotificationConfigurationResponse, *_nethttp.Response, error) { - res := &TestNotificationConfigurationResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/testNotificationConfiguration", ctxs...) - return *res, httpRes, err + res := &TestNotificationConfigurationResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/testNotificationConfiguration", ctxs...) + return *res, httpRes, err } /* -UpdateNotificationConfigurationPost Update an existing notification subscription configuration. +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 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 */ func (a PlatformsNotificationConfiguration) UpdateNotificationConfiguration(req *UpdateNotificationConfigurationRequest, ctxs ..._context.Context) (GetNotificationConfigurationResponse, *_nethttp.Response, error) { - res := &GetNotificationConfigurationResponse{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/updateNotificationConfiguration", ctxs...) - return *res, httpRes, err + res := &GetNotificationConfigurationResponse{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/updateNotificationConfiguration", ctxs...) + return *res, httpRes, err } diff --git a/src/platformsnotificationconfiguration/model_create_notification_configuration_request.go b/src/platformsnotificationconfiguration/model_create_notification_configuration_request.go index 0c3292b26..2e20c0951 100644 --- a/src/platformsnotificationconfiguration/model_create_notification_configuration_request.go +++ b/src/platformsnotificationconfiguration/model_create_notification_configuration_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsnotificationconfiguration/model_delete_notification_configuration_request.go b/src/platformsnotificationconfiguration/model_delete_notification_configuration_request.go index 5e0faec60..61f787902 100644 --- a/src/platformsnotificationconfiguration/model_delete_notification_configuration_request.go +++ b/src/platformsnotificationconfiguration/model_delete_notification_configuration_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsnotificationconfiguration/model_error_field_type.go b/src/platformsnotificationconfiguration/model_error_field_type.go index bb6f086e8..293b8637e 100644 --- a/src/platformsnotificationconfiguration/model_error_field_type.go +++ b/src/platformsnotificationconfiguration/model_error_field_type.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsnotificationconfiguration/model_exchange_message.go b/src/platformsnotificationconfiguration/model_exchange_message.go index 7bcb9ec78..c6e016012 100644 --- a/src/platformsnotificationconfiguration/model_exchange_message.go +++ b/src/platformsnotificationconfiguration/model_exchange_message.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsnotificationconfiguration/model_field_type.go b/src/platformsnotificationconfiguration/model_field_type.go index 6328f6340..cf674e0c1 100644 --- a/src/platformsnotificationconfiguration/model_field_type.go +++ b/src/platformsnotificationconfiguration/model_field_type.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsnotificationconfiguration/model_generic_response.go b/src/platformsnotificationconfiguration/model_generic_response.go index e430e0767..3de0bc2ca 100644 --- a/src/platformsnotificationconfiguration/model_generic_response.go +++ b/src/platformsnotificationconfiguration/model_generic_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -13,8 +13,8 @@ package platformsnotificationconfiguration 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"` + // 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"` } diff --git a/src/platformsnotificationconfiguration/model_get_notification_configuration_list_response.go b/src/platformsnotificationconfiguration/model_get_notification_configuration_list_response.go index 5a8cca894..1e33588e3 100644 --- a/src/platformsnotificationconfiguration/model_get_notification_configuration_list_response.go +++ b/src/platformsnotificationconfiguration/model_get_notification_configuration_list_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,8 +15,8 @@ type GetNotificationConfigurationListResponse struct { 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"` + // 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"` } diff --git a/src/platformsnotificationconfiguration/model_get_notification_configuration_request.go b/src/platformsnotificationconfiguration/model_get_notification_configuration_request.go index 3cb519524..ae3cc09b0 100644 --- a/src/platformsnotificationconfiguration/model_get_notification_configuration_request.go +++ b/src/platformsnotificationconfiguration/model_get_notification_configuration_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsnotificationconfiguration/model_get_notification_configuration_response.go b/src/platformsnotificationconfiguration/model_get_notification_configuration_response.go index 20529efd3..eb6180178 100644 --- a/src/platformsnotificationconfiguration/model_get_notification_configuration_response.go +++ b/src/platformsnotificationconfiguration/model_get_notification_configuration_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -14,8 +14,8 @@ 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"` + // 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"` } diff --git a/src/platformsnotificationconfiguration/model_notification_configuration_details.go b/src/platformsnotificationconfiguration/model_notification_configuration_details.go index 57b6e66f8..64daac110 100644 --- a/src/platformsnotificationconfiguration/model_notification_configuration_details.go +++ b/src/platformsnotificationconfiguration/model_notification_configuration_details.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -15,7 +15,7 @@ type NotificationConfigurationDetails struct { 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. >Required when creating a configuration, forbidden when updating a configuration. + // 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"` diff --git a/src/platformsnotificationconfiguration/model_notification_event_configuration.go b/src/platformsnotificationconfiguration/model_notification_event_configuration.go index 1921e50b6..5c223ade2 100644 --- a/src/platformsnotificationconfiguration/model_notification_event_configuration.go +++ b/src/platformsnotificationconfiguration/model_notification_event_configuration.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsnotificationconfiguration/model_test_notification_configuration_request.go b/src/platformsnotificationconfiguration/model_test_notification_configuration_request.go index c701b3746..db8f6373c 100644 --- a/src/platformsnotificationconfiguration/model_test_notification_configuration_request.go +++ b/src/platformsnotificationconfiguration/model_test_notification_configuration_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsnotificationconfiguration/model_test_notification_configuration_response.go b/src/platformsnotificationconfiguration/model_test_notification_configuration_response.go index 558bff716..062e858db 100644 --- a/src/platformsnotificationconfiguration/model_test_notification_configuration_response.go +++ b/src/platformsnotificationconfiguration/model_test_notification_configuration_response.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ @@ -23,8 +23,8 @@ type TestNotificationConfigurationResponse struct { 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"` + // 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"` } diff --git a/src/platformsnotificationconfiguration/model_update_notification_configuration_request.go b/src/platformsnotificationconfiguration/model_update_notification_configuration_request.go index 64470a9f5..48276d7b1 100644 --- a/src/platformsnotificationconfiguration/model_update_notification_configuration_request.go +++ b/src/platformsnotificationconfiguration/model_update_notification_configuration_request.go @@ -1,9 +1,9 @@ /* * Adyen for Platforms: Notification Configuration API * - * 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](https://docs.adyen.com/marketpay/marketpay-notifications). ## 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 [Support Team](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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/v1/createNotificationConfiguration ``` + * 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](https://docs.adyen.com/platforms/notifications). ## 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](https://support.adyen.com/hc/en-us/requests/new). 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](https://docs.adyen.com/development-resources/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 ``` * - * API version: 5 + * API version: 6 * Contact: support@adyen.com * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ diff --git a/src/platformsnotificationevents/model_account_close_notification.go b/src/platformsnotificationevents/model_account_close_notification.go new file mode 100644 index 000000000..1d280b158 --- /dev/null +++ b/src/platformsnotificationevents/model_account_close_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountCloseNotification struct for AccountCloseNotification +type AccountCloseNotification struct { + Content CloseAccountResponse `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountCloseNotification instantiates a new AccountCloseNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountCloseNotification(content CloseAccountResponse, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountCloseNotification { + this := AccountCloseNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountCloseNotificationWithDefaults instantiates a new AccountCloseNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountCloseNotificationWithDefaults() *AccountCloseNotification { + this := AccountCloseNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *AccountCloseNotification) GetContent() CloseAccountResponse { + if o == nil { + var ret CloseAccountResponse + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *AccountCloseNotification) GetContentOk() (*CloseAccountResponse, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *AccountCloseNotification) SetContent(v CloseAccountResponse) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountCloseNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountCloseNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountCloseNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountCloseNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountCloseNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountCloseNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountCloseNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountCloseNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountCloseNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountCloseNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountCloseNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountCloseNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountCloseNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountCloseNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountCloseNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountCloseNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountCloseNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountCloseNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountCloseNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountCloseNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountCloseNotification struct { + value *AccountCloseNotification + isSet bool +} + +func (v NullableAccountCloseNotification) Get() *AccountCloseNotification { + return v.value +} + +func (v *NullableAccountCloseNotification) Set(val *AccountCloseNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountCloseNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountCloseNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountCloseNotification(val *AccountCloseNotification) *NullableAccountCloseNotification { + return &NullableAccountCloseNotification{value: val, isSet: true} +} + +func (v NullableAccountCloseNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountCloseNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_create_notification.go b/src/platformsnotificationevents/model_account_create_notification.go new file mode 100644 index 000000000..619ef4a0c --- /dev/null +++ b/src/platformsnotificationevents/model_account_create_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountCreateNotification struct for AccountCreateNotification +type AccountCreateNotification struct { + Content CreateAccountResponse `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountCreateNotification instantiates a new AccountCreateNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountCreateNotification(content CreateAccountResponse, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountCreateNotification { + this := AccountCreateNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountCreateNotificationWithDefaults instantiates a new AccountCreateNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountCreateNotificationWithDefaults() *AccountCreateNotification { + this := AccountCreateNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *AccountCreateNotification) GetContent() CreateAccountResponse { + if o == nil { + var ret CreateAccountResponse + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *AccountCreateNotification) GetContentOk() (*CreateAccountResponse, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *AccountCreateNotification) SetContent(v CreateAccountResponse) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountCreateNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountCreateNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountCreateNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountCreateNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountCreateNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountCreateNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountCreateNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountCreateNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountCreateNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountCreateNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountCreateNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountCreateNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountCreateNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountCreateNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountCreateNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountCreateNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountCreateNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountCreateNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountCreateNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountCreateNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountCreateNotification struct { + value *AccountCreateNotification + isSet bool +} + +func (v NullableAccountCreateNotification) Get() *AccountCreateNotification { + return v.value +} + +func (v *NullableAccountCreateNotification) Set(val *AccountCreateNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountCreateNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountCreateNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountCreateNotification(val *AccountCreateNotification) *NullableAccountCreateNotification { + return &NullableAccountCreateNotification{value: val, isSet: true} +} + +func (v NullableAccountCreateNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountCreateNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_event.go b/src/platformsnotificationevents/model_account_event.go new file mode 100644 index 000000000..25c0b5ad1 --- /dev/null +++ b/src/platformsnotificationevents/model_account_event.go @@ -0,0 +1,171 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountEvent struct for AccountEvent +type AccountEvent struct { + // The event. >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. For more information, refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). + Event string `json:"event"` + // The date on which the event will take place. + ExecutionDate time.Time `json:"executionDate"` + // The reason why this event has been created. + Reason string `json:"reason"` +} + +// NewAccountEvent instantiates a new AccountEvent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountEvent(event string, executionDate time.Time, reason string, ) *AccountEvent { + this := AccountEvent{} + this.Event = event + this.ExecutionDate = executionDate + this.Reason = reason + return &this +} + +// NewAccountEventWithDefaults instantiates a new AccountEvent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountEventWithDefaults() *AccountEvent { + this := AccountEvent{} + return &this +} + +// GetEvent returns the Event field value +func (o *AccountEvent) GetEvent() string { + if o == nil { + var ret string + return ret + } + + return o.Event +} + +// GetEventOk returns a tuple with the Event field value +// and a boolean to check if the value has been set. +func (o *AccountEvent) GetEventOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Event, true +} + +// SetEvent sets field value +func (o *AccountEvent) SetEvent(v string) { + o.Event = v +} + +// GetExecutionDate returns the ExecutionDate field value +func (o *AccountEvent) GetExecutionDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.ExecutionDate +} + +// GetExecutionDateOk returns a tuple with the ExecutionDate field value +// and a boolean to check if the value has been set. +func (o *AccountEvent) GetExecutionDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.ExecutionDate, true +} + +// SetExecutionDate sets field value +func (o *AccountEvent) SetExecutionDate(v time.Time) { + o.ExecutionDate = v +} + +// GetReason returns the Reason field value +func (o *AccountEvent) GetReason() string { + if o == nil { + var ret string + return ret + } + + return o.Reason +} + +// GetReasonOk returns a tuple with the Reason field value +// and a boolean to check if the value has been set. +func (o *AccountEvent) GetReasonOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Reason, true +} + +// SetReason sets field value +func (o *AccountEvent) SetReason(v string) { + o.Reason = v +} + +func (o AccountEvent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["event"] = o.Event + } + if true { + toSerialize["executionDate"] = o.ExecutionDate + } + if true { + toSerialize["reason"] = o.Reason + } + return json.Marshal(toSerialize) +} + +type NullableAccountEvent struct { + value *AccountEvent + isSet bool +} + +func (v NullableAccountEvent) Get() *AccountEvent { + return v.value +} + +func (v *NullableAccountEvent) Set(val *AccountEvent) { + v.value = val + v.isSet = true +} + +func (v NullableAccountEvent) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountEvent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountEvent(val *AccountEvent) *NullableAccountEvent { + return &NullableAccountEvent{value: val, isSet: true} +} + +func (v NullableAccountEvent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountEvent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_funds_below_threshold_notification.go b/src/platformsnotificationevents/model_account_funds_below_threshold_notification.go new file mode 100644 index 000000000..8a92e4d49 --- /dev/null +++ b/src/platformsnotificationevents/model_account_funds_below_threshold_notification.go @@ -0,0 +1,303 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountFundsBelowThresholdNotification struct for AccountFundsBelowThresholdNotification +type AccountFundsBelowThresholdNotification struct { + Content *AccountFundsBelowThresholdNotificationContent `json:"content,omitempty"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountFundsBelowThresholdNotification instantiates a new AccountFundsBelowThresholdNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountFundsBelowThresholdNotification(eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountFundsBelowThresholdNotification { + this := AccountFundsBelowThresholdNotification{} + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountFundsBelowThresholdNotificationWithDefaults instantiates a new AccountFundsBelowThresholdNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountFundsBelowThresholdNotificationWithDefaults() *AccountFundsBelowThresholdNotification { + this := AccountFundsBelowThresholdNotification{} + return &this +} + +// GetContent returns the Content field value if set, zero value otherwise. +func (o *AccountFundsBelowThresholdNotification) GetContent() AccountFundsBelowThresholdNotificationContent { + if o == nil || o.Content == nil { + var ret AccountFundsBelowThresholdNotificationContent + return ret + } + return *o.Content +} + +// GetContentOk returns a tuple with the Content field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotification) GetContentOk() (*AccountFundsBelowThresholdNotificationContent, bool) { + if o == nil || o.Content == nil { + return nil, false + } + return o.Content, true +} + +// HasContent returns a boolean if a field has been set. +func (o *AccountFundsBelowThresholdNotification) HasContent() bool { + if o != nil && o.Content != nil { + return true + } + + return false +} + +// SetContent gets a reference to the given AccountFundsBelowThresholdNotificationContent and assigns it to the Content field. +func (o *AccountFundsBelowThresholdNotification) SetContent(v AccountFundsBelowThresholdNotificationContent) { + o.Content = &v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountFundsBelowThresholdNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountFundsBelowThresholdNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountFundsBelowThresholdNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountFundsBelowThresholdNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountFundsBelowThresholdNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountFundsBelowThresholdNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountFundsBelowThresholdNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountFundsBelowThresholdNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountFundsBelowThresholdNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountFundsBelowThresholdNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountFundsBelowThresholdNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountFundsBelowThresholdNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountFundsBelowThresholdNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountFundsBelowThresholdNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Content != nil { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountFundsBelowThresholdNotification struct { + value *AccountFundsBelowThresholdNotification + isSet bool +} + +func (v NullableAccountFundsBelowThresholdNotification) Get() *AccountFundsBelowThresholdNotification { + return v.value +} + +func (v *NullableAccountFundsBelowThresholdNotification) Set(val *AccountFundsBelowThresholdNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountFundsBelowThresholdNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountFundsBelowThresholdNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountFundsBelowThresholdNotification(val *AccountFundsBelowThresholdNotification) *NullableAccountFundsBelowThresholdNotification { + return &NullableAccountFundsBelowThresholdNotification{value: val, isSet: true} +} + +func (v NullableAccountFundsBelowThresholdNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountFundsBelowThresholdNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_funds_below_threshold_notification_content.go b/src/platformsnotificationevents/model_account_funds_below_threshold_notification_content.go new file mode 100644 index 000000000..9033212e3 --- /dev/null +++ b/src/platformsnotificationevents/model_account_funds_below_threshold_notification_content.go @@ -0,0 +1,241 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// AccountFundsBelowThresholdNotificationContent struct for AccountFundsBelowThresholdNotificationContent +type AccountFundsBelowThresholdNotificationContent struct { + // The code of the account with funds under threshold + AccountCode string `json:"accountCode"` + BalanceDate *LocalDate `json:"balanceDate,omitempty"` + CurrentFunds *Amount `json:"currentFunds,omitempty"` + FundThreshold Amount `json:"fundThreshold"` + // The code of the merchant account. + MerchantAccountCode string `json:"merchantAccountCode"` +} + +// NewAccountFundsBelowThresholdNotificationContent instantiates a new AccountFundsBelowThresholdNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountFundsBelowThresholdNotificationContent(accountCode string, fundThreshold Amount, merchantAccountCode string, ) *AccountFundsBelowThresholdNotificationContent { + this := AccountFundsBelowThresholdNotificationContent{} + this.AccountCode = accountCode + this.FundThreshold = fundThreshold + this.MerchantAccountCode = merchantAccountCode + return &this +} + +// NewAccountFundsBelowThresholdNotificationContentWithDefaults instantiates a new AccountFundsBelowThresholdNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountFundsBelowThresholdNotificationContentWithDefaults() *AccountFundsBelowThresholdNotificationContent { + this := AccountFundsBelowThresholdNotificationContent{} + return &this +} + +// GetAccountCode returns the AccountCode field value +func (o *AccountFundsBelowThresholdNotificationContent) GetAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountCode +} + +// GetAccountCodeOk returns a tuple with the AccountCode field value +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotificationContent) GetAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountCode, true +} + +// SetAccountCode sets field value +func (o *AccountFundsBelowThresholdNotificationContent) SetAccountCode(v string) { + o.AccountCode = v +} + +// GetBalanceDate returns the BalanceDate field value if set, zero value otherwise. +func (o *AccountFundsBelowThresholdNotificationContent) GetBalanceDate() LocalDate { + if o == nil || o.BalanceDate == nil { + var ret LocalDate + return ret + } + return *o.BalanceDate +} + +// GetBalanceDateOk returns a tuple with the BalanceDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotificationContent) GetBalanceDateOk() (*LocalDate, bool) { + if o == nil || o.BalanceDate == nil { + return nil, false + } + return o.BalanceDate, true +} + +// HasBalanceDate returns a boolean if a field has been set. +func (o *AccountFundsBelowThresholdNotificationContent) HasBalanceDate() bool { + if o != nil && o.BalanceDate != nil { + return true + } + + return false +} + +// SetBalanceDate gets a reference to the given LocalDate and assigns it to the BalanceDate field. +func (o *AccountFundsBelowThresholdNotificationContent) SetBalanceDate(v LocalDate) { + o.BalanceDate = &v +} + +// GetCurrentFunds returns the CurrentFunds field value if set, zero value otherwise. +func (o *AccountFundsBelowThresholdNotificationContent) GetCurrentFunds() Amount { + if o == nil || o.CurrentFunds == nil { + var ret Amount + return ret + } + return *o.CurrentFunds +} + +// GetCurrentFundsOk returns a tuple with the CurrentFunds field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotificationContent) GetCurrentFundsOk() (*Amount, bool) { + if o == nil || o.CurrentFunds == nil { + return nil, false + } + return o.CurrentFunds, true +} + +// HasCurrentFunds returns a boolean if a field has been set. +func (o *AccountFundsBelowThresholdNotificationContent) HasCurrentFunds() bool { + if o != nil && o.CurrentFunds != nil { + return true + } + + return false +} + +// SetCurrentFunds gets a reference to the given Amount and assigns it to the CurrentFunds field. +func (o *AccountFundsBelowThresholdNotificationContent) SetCurrentFunds(v Amount) { + o.CurrentFunds = &v +} + +// GetFundThreshold returns the FundThreshold field value +func (o *AccountFundsBelowThresholdNotificationContent) GetFundThreshold() Amount { + if o == nil { + var ret Amount + return ret + } + + return o.FundThreshold +} + +// GetFundThresholdOk returns a tuple with the FundThreshold field value +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotificationContent) GetFundThresholdOk() (*Amount, bool) { + if o == nil { + return nil, false + } + return &o.FundThreshold, true +} + +// SetFundThreshold sets field value +func (o *AccountFundsBelowThresholdNotificationContent) SetFundThreshold(v Amount) { + o.FundThreshold = v +} + +// GetMerchantAccountCode returns the MerchantAccountCode field value +func (o *AccountFundsBelowThresholdNotificationContent) GetMerchantAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.MerchantAccountCode +} + +// GetMerchantAccountCodeOk returns a tuple with the MerchantAccountCode field value +// and a boolean to check if the value has been set. +func (o *AccountFundsBelowThresholdNotificationContent) GetMerchantAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.MerchantAccountCode, true +} + +// SetMerchantAccountCode sets field value +func (o *AccountFundsBelowThresholdNotificationContent) SetMerchantAccountCode(v string) { + o.MerchantAccountCode = v +} + +func (o AccountFundsBelowThresholdNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["accountCode"] = o.AccountCode + } + if o.BalanceDate != nil { + toSerialize["balanceDate"] = o.BalanceDate + } + if o.CurrentFunds != nil { + toSerialize["currentFunds"] = o.CurrentFunds + } + if true { + toSerialize["fundThreshold"] = o.FundThreshold + } + if true { + toSerialize["merchantAccountCode"] = o.MerchantAccountCode + } + return json.Marshal(toSerialize) +} + +type NullableAccountFundsBelowThresholdNotificationContent struct { + value *AccountFundsBelowThresholdNotificationContent + isSet bool +} + +func (v NullableAccountFundsBelowThresholdNotificationContent) Get() *AccountFundsBelowThresholdNotificationContent { + return v.value +} + +func (v *NullableAccountFundsBelowThresholdNotificationContent) Set(val *AccountFundsBelowThresholdNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableAccountFundsBelowThresholdNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountFundsBelowThresholdNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountFundsBelowThresholdNotificationContent(val *AccountFundsBelowThresholdNotificationContent) *NullableAccountFundsBelowThresholdNotificationContent { + return &NullableAccountFundsBelowThresholdNotificationContent{value: val, isSet: true} +} + +func (v NullableAccountFundsBelowThresholdNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountFundsBelowThresholdNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_create_notification.go b/src/platformsnotificationevents/model_account_holder_create_notification.go new file mode 100644 index 000000000..2d135a7c9 --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_create_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountHolderCreateNotification struct for AccountHolderCreateNotification +type AccountHolderCreateNotification struct { + Content CreateAccountHolderResponse `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountHolderCreateNotification instantiates a new AccountHolderCreateNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderCreateNotification(content CreateAccountHolderResponse, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountHolderCreateNotification { + this := AccountHolderCreateNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountHolderCreateNotificationWithDefaults instantiates a new AccountHolderCreateNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderCreateNotificationWithDefaults() *AccountHolderCreateNotification { + this := AccountHolderCreateNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *AccountHolderCreateNotification) GetContent() CreateAccountHolderResponse { + if o == nil { + var ret CreateAccountHolderResponse + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *AccountHolderCreateNotification) GetContentOk() (*CreateAccountHolderResponse, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *AccountHolderCreateNotification) SetContent(v CreateAccountHolderResponse) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountHolderCreateNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderCreateNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountHolderCreateNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountHolderCreateNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountHolderCreateNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountHolderCreateNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountHolderCreateNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountHolderCreateNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountHolderCreateNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountHolderCreateNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountHolderCreateNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountHolderCreateNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountHolderCreateNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountHolderCreateNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountHolderCreateNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountHolderCreateNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountHolderCreateNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountHolderCreateNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountHolderCreateNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountHolderCreateNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderCreateNotification struct { + value *AccountHolderCreateNotification + isSet bool +} + +func (v NullableAccountHolderCreateNotification) Get() *AccountHolderCreateNotification { + return v.value +} + +func (v *NullableAccountHolderCreateNotification) Set(val *AccountHolderCreateNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderCreateNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderCreateNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderCreateNotification(val *AccountHolderCreateNotification) *NullableAccountHolderCreateNotification { + return &NullableAccountHolderCreateNotification{value: val, isSet: true} +} + +func (v NullableAccountHolderCreateNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderCreateNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_details.go b/src/platformsnotificationevents/model_account_holder_details.go new file mode 100644 index 000000000..db50c8f8b --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_details.go @@ -0,0 +1,463 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// AccountHolderDetails struct for AccountHolderDetails +type AccountHolderDetails struct { + Address *ViasAddress `json:"address,omitempty"` + // Each of the bank accounts associated with the account holder. > Each array entry should represent one bank account. > For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). + BankAccountDetails *[]BankAccountDetail `json:"bankAccountDetails,omitempty"` + // The opaque reference value returned by the Adyen API during bank account login. + BankAggregatorDataReference *string `json:"bankAggregatorDataReference,omitempty"` + BusinessDetails *BusinessDetails `json:"businessDetails,omitempty"` + // The email address of the account holder. + Email string `json:"email"` + // The phone number of the account holder provided as a single string. It will be handled as a landline phone. **Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\" + FullPhoneNumber string `json:"fullPhoneNumber"` + IndividualDetails *IndividualDetails `json:"individualDetails,omitempty"` + // The Merchant Category Code of the account holder. > If not specified in the request, this will be derived from the platform account (which is configured by Adyen). + MerchantCategoryCode *string `json:"merchantCategoryCode,omitempty"` + // A set of key and value pairs for general use by the account holder or merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + Metadata *map[string]string `json:"metadata,omitempty"` + // Each of the card tokens associated with the account holder. > Each array entry should represent one card token. > For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). + PayoutMethods *[]PayoutMethod `json:"payoutMethods,omitempty"` + // The URL of the website of the account holder. + WebAddress string `json:"webAddress"` +} + +// NewAccountHolderDetails instantiates a new AccountHolderDetails object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderDetails(email string, fullPhoneNumber string, webAddress string, ) *AccountHolderDetails { + this := AccountHolderDetails{} + this.Email = email + this.FullPhoneNumber = fullPhoneNumber + this.WebAddress = webAddress + return &this +} + +// NewAccountHolderDetailsWithDefaults instantiates a new AccountHolderDetails object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderDetailsWithDefaults() *AccountHolderDetails { + this := AccountHolderDetails{} + return &this +} + +// GetAddress returns the Address field value if set, zero value otherwise. +func (o *AccountHolderDetails) GetAddress() ViasAddress { + if o == nil || o.Address == nil { + var ret ViasAddress + return ret + } + return *o.Address +} + +// GetAddressOk returns a tuple with the Address field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetAddressOk() (*ViasAddress, bool) { + if o == nil || o.Address == nil { + return nil, false + } + return o.Address, true +} + +// HasAddress returns a boolean if a field has been set. +func (o *AccountHolderDetails) HasAddress() bool { + if o != nil && o.Address != nil { + return true + } + + return false +} + +// SetAddress gets a reference to the given ViasAddress and assigns it to the Address field. +func (o *AccountHolderDetails) SetAddress(v ViasAddress) { + o.Address = &v +} + +// GetBankAccountDetails returns the BankAccountDetails field value if set, zero value otherwise. +func (o *AccountHolderDetails) GetBankAccountDetails() []BankAccountDetail { + if o == nil || o.BankAccountDetails == nil { + var ret []BankAccountDetail + return ret + } + return *o.BankAccountDetails +} + +// GetBankAccountDetailsOk returns a tuple with the BankAccountDetails field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetBankAccountDetailsOk() (*[]BankAccountDetail, bool) { + if o == nil || o.BankAccountDetails == nil { + return nil, false + } + return o.BankAccountDetails, true +} + +// HasBankAccountDetails returns a boolean if a field has been set. +func (o *AccountHolderDetails) HasBankAccountDetails() bool { + if o != nil && o.BankAccountDetails != nil { + return true + } + + return false +} + +// SetBankAccountDetails gets a reference to the given []BankAccountDetail and assigns it to the BankAccountDetails field. +func (o *AccountHolderDetails) SetBankAccountDetails(v []BankAccountDetail) { + o.BankAccountDetails = &v +} + +// GetBankAggregatorDataReference returns the BankAggregatorDataReference field value if set, zero value otherwise. +func (o *AccountHolderDetails) GetBankAggregatorDataReference() string { + if o == nil || o.BankAggregatorDataReference == nil { + var ret string + return ret + } + return *o.BankAggregatorDataReference +} + +// GetBankAggregatorDataReferenceOk returns a tuple with the BankAggregatorDataReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetBankAggregatorDataReferenceOk() (*string, bool) { + if o == nil || o.BankAggregatorDataReference == nil { + return nil, false + } + return o.BankAggregatorDataReference, true +} + +// HasBankAggregatorDataReference returns a boolean if a field has been set. +func (o *AccountHolderDetails) HasBankAggregatorDataReference() bool { + if o != nil && o.BankAggregatorDataReference != nil { + return true + } + + return false +} + +// SetBankAggregatorDataReference gets a reference to the given string and assigns it to the BankAggregatorDataReference field. +func (o *AccountHolderDetails) SetBankAggregatorDataReference(v string) { + o.BankAggregatorDataReference = &v +} + +// GetBusinessDetails returns the BusinessDetails field value if set, zero value otherwise. +func (o *AccountHolderDetails) GetBusinessDetails() BusinessDetails { + if o == nil || o.BusinessDetails == nil { + var ret BusinessDetails + return ret + } + return *o.BusinessDetails +} + +// GetBusinessDetailsOk returns a tuple with the BusinessDetails field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetBusinessDetailsOk() (*BusinessDetails, bool) { + if o == nil || o.BusinessDetails == nil { + return nil, false + } + return o.BusinessDetails, true +} + +// HasBusinessDetails returns a boolean if a field has been set. +func (o *AccountHolderDetails) HasBusinessDetails() bool { + if o != nil && o.BusinessDetails != nil { + return true + } + + return false +} + +// SetBusinessDetails gets a reference to the given BusinessDetails and assigns it to the BusinessDetails field. +func (o *AccountHolderDetails) SetBusinessDetails(v BusinessDetails) { + o.BusinessDetails = &v +} + +// GetEmail returns the Email field value +func (o *AccountHolderDetails) GetEmail() string { + if o == nil { + var ret string + return ret + } + + return o.Email +} + +// GetEmailOk returns a tuple with the Email field value +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetEmailOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Email, true +} + +// SetEmail sets field value +func (o *AccountHolderDetails) SetEmail(v string) { + o.Email = v +} + +// GetFullPhoneNumber returns the FullPhoneNumber field value +func (o *AccountHolderDetails) GetFullPhoneNumber() string { + if o == nil { + var ret string + return ret + } + + return o.FullPhoneNumber +} + +// GetFullPhoneNumberOk returns a tuple with the FullPhoneNumber field value +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetFullPhoneNumberOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.FullPhoneNumber, true +} + +// SetFullPhoneNumber sets field value +func (o *AccountHolderDetails) SetFullPhoneNumber(v string) { + o.FullPhoneNumber = v +} + +// GetIndividualDetails returns the IndividualDetails field value if set, zero value otherwise. +func (o *AccountHolderDetails) GetIndividualDetails() IndividualDetails { + if o == nil || o.IndividualDetails == nil { + var ret IndividualDetails + return ret + } + return *o.IndividualDetails +} + +// GetIndividualDetailsOk returns a tuple with the IndividualDetails field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetIndividualDetailsOk() (*IndividualDetails, bool) { + if o == nil || o.IndividualDetails == nil { + return nil, false + } + return o.IndividualDetails, true +} + +// HasIndividualDetails returns a boolean if a field has been set. +func (o *AccountHolderDetails) HasIndividualDetails() bool { + if o != nil && o.IndividualDetails != nil { + return true + } + + return false +} + +// SetIndividualDetails gets a reference to the given IndividualDetails and assigns it to the IndividualDetails field. +func (o *AccountHolderDetails) SetIndividualDetails(v IndividualDetails) { + o.IndividualDetails = &v +} + +// GetMerchantCategoryCode returns the MerchantCategoryCode field value if set, zero value otherwise. +func (o *AccountHolderDetails) GetMerchantCategoryCode() string { + if o == nil || o.MerchantCategoryCode == nil { + var ret string + return ret + } + return *o.MerchantCategoryCode +} + +// GetMerchantCategoryCodeOk returns a tuple with the MerchantCategoryCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetMerchantCategoryCodeOk() (*string, bool) { + if o == nil || o.MerchantCategoryCode == nil { + return nil, false + } + return o.MerchantCategoryCode, true +} + +// HasMerchantCategoryCode returns a boolean if a field has been set. +func (o *AccountHolderDetails) HasMerchantCategoryCode() bool { + if o != nil && o.MerchantCategoryCode != nil { + return true + } + + return false +} + +// SetMerchantCategoryCode gets a reference to the given string and assigns it to the MerchantCategoryCode field. +func (o *AccountHolderDetails) SetMerchantCategoryCode(v string) { + o.MerchantCategoryCode = &v +} + +// GetMetadata returns the Metadata field value if set, zero value otherwise. +func (o *AccountHolderDetails) GetMetadata() map[string]string { + if o == nil || o.Metadata == nil { + var ret map[string]string + return ret + } + return *o.Metadata +} + +// GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetMetadataOk() (*map[string]string, bool) { + if o == nil || o.Metadata == nil { + return nil, false + } + return o.Metadata, true +} + +// HasMetadata returns a boolean if a field has been set. +func (o *AccountHolderDetails) HasMetadata() bool { + if o != nil && o.Metadata != nil { + return true + } + + return false +} + +// SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field. +func (o *AccountHolderDetails) SetMetadata(v map[string]string) { + o.Metadata = &v +} + +// GetPayoutMethods returns the PayoutMethods field value if set, zero value otherwise. +func (o *AccountHolderDetails) GetPayoutMethods() []PayoutMethod { + if o == nil || o.PayoutMethods == nil { + var ret []PayoutMethod + return ret + } + return *o.PayoutMethods +} + +// GetPayoutMethodsOk returns a tuple with the PayoutMethods field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetPayoutMethodsOk() (*[]PayoutMethod, bool) { + if o == nil || o.PayoutMethods == nil { + return nil, false + } + return o.PayoutMethods, true +} + +// HasPayoutMethods returns a boolean if a field has been set. +func (o *AccountHolderDetails) HasPayoutMethods() bool { + if o != nil && o.PayoutMethods != nil { + return true + } + + return false +} + +// SetPayoutMethods gets a reference to the given []PayoutMethod and assigns it to the PayoutMethods field. +func (o *AccountHolderDetails) SetPayoutMethods(v []PayoutMethod) { + o.PayoutMethods = &v +} + +// GetWebAddress returns the WebAddress field value +func (o *AccountHolderDetails) GetWebAddress() string { + if o == nil { + var ret string + return ret + } + + return o.WebAddress +} + +// GetWebAddressOk returns a tuple with the WebAddress field value +// and a boolean to check if the value has been set. +func (o *AccountHolderDetails) GetWebAddressOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.WebAddress, true +} + +// SetWebAddress sets field value +func (o *AccountHolderDetails) SetWebAddress(v string) { + o.WebAddress = v +} + +func (o AccountHolderDetails) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Address != nil { + toSerialize["address"] = o.Address + } + if o.BankAccountDetails != nil { + toSerialize["bankAccountDetails"] = o.BankAccountDetails + } + if o.BankAggregatorDataReference != nil { + toSerialize["bankAggregatorDataReference"] = o.BankAggregatorDataReference + } + if o.BusinessDetails != nil { + toSerialize["businessDetails"] = o.BusinessDetails + } + if true { + toSerialize["email"] = o.Email + } + if true { + toSerialize["fullPhoneNumber"] = o.FullPhoneNumber + } + if o.IndividualDetails != nil { + toSerialize["individualDetails"] = o.IndividualDetails + } + if o.MerchantCategoryCode != nil { + toSerialize["merchantCategoryCode"] = o.MerchantCategoryCode + } + if o.Metadata != nil { + toSerialize["metadata"] = o.Metadata + } + if o.PayoutMethods != nil { + toSerialize["payoutMethods"] = o.PayoutMethods + } + if true { + toSerialize["webAddress"] = o.WebAddress + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderDetails struct { + value *AccountHolderDetails + isSet bool +} + +func (v NullableAccountHolderDetails) Get() *AccountHolderDetails { + return v.value +} + +func (v *NullableAccountHolderDetails) Set(val *AccountHolderDetails) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderDetails) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderDetails) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderDetails(val *AccountHolderDetails) *NullableAccountHolderDetails { + return &NullableAccountHolderDetails{value: val, isSet: true} +} + +func (v NullableAccountHolderDetails) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderDetails) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_payout_notification.go b/src/platformsnotificationevents/model_account_holder_payout_notification.go new file mode 100644 index 000000000..39e505542 --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_payout_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountHolderPayoutNotification struct for AccountHolderPayoutNotification +type AccountHolderPayoutNotification struct { + Content AccountHolderPayoutNotificationContent `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountHolderPayoutNotification instantiates a new AccountHolderPayoutNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderPayoutNotification(content AccountHolderPayoutNotificationContent, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountHolderPayoutNotification { + this := AccountHolderPayoutNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountHolderPayoutNotificationWithDefaults instantiates a new AccountHolderPayoutNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderPayoutNotificationWithDefaults() *AccountHolderPayoutNotification { + this := AccountHolderPayoutNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *AccountHolderPayoutNotification) GetContent() AccountHolderPayoutNotificationContent { + if o == nil { + var ret AccountHolderPayoutNotificationContent + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotification) GetContentOk() (*AccountHolderPayoutNotificationContent, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *AccountHolderPayoutNotification) SetContent(v AccountHolderPayoutNotificationContent) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountHolderPayoutNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountHolderPayoutNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountHolderPayoutNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountHolderPayoutNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountHolderPayoutNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountHolderPayoutNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountHolderPayoutNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountHolderPayoutNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountHolderPayoutNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountHolderPayoutNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountHolderPayoutNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountHolderPayoutNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderPayoutNotification struct { + value *AccountHolderPayoutNotification + isSet bool +} + +func (v NullableAccountHolderPayoutNotification) Get() *AccountHolderPayoutNotification { + return v.value +} + +func (v *NullableAccountHolderPayoutNotification) Set(val *AccountHolderPayoutNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderPayoutNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderPayoutNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderPayoutNotification(val *AccountHolderPayoutNotification) *NullableAccountHolderPayoutNotification { + return &NullableAccountHolderPayoutNotification{value: val, isSet: true} +} + +func (v NullableAccountHolderPayoutNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderPayoutNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_payout_notification_content.go b/src/platformsnotificationevents/model_account_holder_payout_notification_content.go new file mode 100644 index 000000000..3a3ff4c60 --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_payout_notification_content.go @@ -0,0 +1,655 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// AccountHolderPayoutNotificationContent struct for AccountHolderPayoutNotificationContent +type AccountHolderPayoutNotificationContent struct { + // The code of the account from which the payout was made. + AccountCode string `json:"accountCode"` + // The code of the Account Holder to which the payout was made. + AccountHolderCode string `json:"accountHolderCode"` + // The payout amounts (per currency). + Amounts *[]Amount `json:"amounts,omitempty"` + BankAccountDetail *BankAccountDetail `json:"bankAccountDetail,omitempty"` + // A description of the payout. + Description *string `json:"description,omitempty"` + EstimatedArrivalDate *LocalDate `json:"estimatedArrivalDate,omitempty"` + // Invalid fields list. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + // The merchant reference. + MerchantReference *string `json:"merchantReference,omitempty"` + // The PSP reference of the original payout. + OriginalPspReference *string `json:"originalPspReference,omitempty"` + // Payout account country. + PayoutAccountCountry *string `json:"payoutAccountCountry,omitempty"` + // Payout bank account number. + PayoutAccountNumber *string `json:"payoutAccountNumber,omitempty"` + // Payout bank name. + PayoutBankName *string `json:"payoutBankName,omitempty"` + // Payout branch code. + PayoutBranchCode *string `json:"payoutBranchCode,omitempty"` + // Payout transaction id. + PayoutReference *int64 `json:"payoutReference,omitempty"` + // Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + PayoutSpeed *string `json:"payoutSpeed,omitempty"` + Status *OperationStatus `json:"status,omitempty"` +} + +// NewAccountHolderPayoutNotificationContent instantiates a new AccountHolderPayoutNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderPayoutNotificationContent(accountCode string, accountHolderCode string, ) *AccountHolderPayoutNotificationContent { + this := AccountHolderPayoutNotificationContent{} + this.AccountCode = accountCode + this.AccountHolderCode = accountHolderCode + return &this +} + +// NewAccountHolderPayoutNotificationContentWithDefaults instantiates a new AccountHolderPayoutNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderPayoutNotificationContentWithDefaults() *AccountHolderPayoutNotificationContent { + this := AccountHolderPayoutNotificationContent{} + return &this +} + +// GetAccountCode returns the AccountCode field value +func (o *AccountHolderPayoutNotificationContent) GetAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountCode +} + +// GetAccountCodeOk returns a tuple with the AccountCode field value +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountCode, true +} + +// SetAccountCode sets field value +func (o *AccountHolderPayoutNotificationContent) SetAccountCode(v string) { + o.AccountCode = v +} + +// GetAccountHolderCode returns the AccountHolderCode field value +func (o *AccountHolderPayoutNotificationContent) GetAccountHolderCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountHolderCode +} + +// GetAccountHolderCodeOk returns a tuple with the AccountHolderCode field value +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetAccountHolderCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountHolderCode, true +} + +// SetAccountHolderCode sets field value +func (o *AccountHolderPayoutNotificationContent) SetAccountHolderCode(v string) { + o.AccountHolderCode = v +} + +// GetAmounts returns the Amounts field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetAmounts() []Amount { + if o == nil || o.Amounts == nil { + var ret []Amount + return ret + } + return *o.Amounts +} + +// GetAmountsOk returns a tuple with the Amounts field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetAmountsOk() (*[]Amount, bool) { + if o == nil || o.Amounts == nil { + return nil, false + } + return o.Amounts, true +} + +// HasAmounts returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasAmounts() bool { + if o != nil && o.Amounts != nil { + return true + } + + return false +} + +// SetAmounts gets a reference to the given []Amount and assigns it to the Amounts field. +func (o *AccountHolderPayoutNotificationContent) SetAmounts(v []Amount) { + o.Amounts = &v +} + +// GetBankAccountDetail returns the BankAccountDetail field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetBankAccountDetail() BankAccountDetail { + if o == nil || o.BankAccountDetail == nil { + var ret BankAccountDetail + return ret + } + return *o.BankAccountDetail +} + +// GetBankAccountDetailOk returns a tuple with the BankAccountDetail field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetBankAccountDetailOk() (*BankAccountDetail, bool) { + if o == nil || o.BankAccountDetail == nil { + return nil, false + } + return o.BankAccountDetail, true +} + +// HasBankAccountDetail returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasBankAccountDetail() bool { + if o != nil && o.BankAccountDetail != nil { + return true + } + + return false +} + +// SetBankAccountDetail gets a reference to the given BankAccountDetail and assigns it to the BankAccountDetail field. +func (o *AccountHolderPayoutNotificationContent) SetBankAccountDetail(v BankAccountDetail) { + o.BankAccountDetail = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetDescriptionOk() (*string, bool) { + if o == nil || o.Description == nil { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *AccountHolderPayoutNotificationContent) SetDescription(v string) { + o.Description = &v +} + +// GetEstimatedArrivalDate returns the EstimatedArrivalDate field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetEstimatedArrivalDate() LocalDate { + if o == nil || o.EstimatedArrivalDate == nil { + var ret LocalDate + return ret + } + return *o.EstimatedArrivalDate +} + +// GetEstimatedArrivalDateOk returns a tuple with the EstimatedArrivalDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetEstimatedArrivalDateOk() (*LocalDate, bool) { + if o == nil || o.EstimatedArrivalDate == nil { + return nil, false + } + return o.EstimatedArrivalDate, true +} + +// HasEstimatedArrivalDate returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasEstimatedArrivalDate() bool { + if o != nil && o.EstimatedArrivalDate != nil { + return true + } + + return false +} + +// SetEstimatedArrivalDate gets a reference to the given LocalDate and assigns it to the EstimatedArrivalDate field. +func (o *AccountHolderPayoutNotificationContent) SetEstimatedArrivalDate(v LocalDate) { + o.EstimatedArrivalDate = &v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *AccountHolderPayoutNotificationContent) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetMerchantReference returns the MerchantReference field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetMerchantReference() string { + if o == nil || o.MerchantReference == nil { + var ret string + return ret + } + return *o.MerchantReference +} + +// GetMerchantReferenceOk returns a tuple with the MerchantReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetMerchantReferenceOk() (*string, bool) { + if o == nil || o.MerchantReference == nil { + return nil, false + } + return o.MerchantReference, true +} + +// HasMerchantReference returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasMerchantReference() bool { + if o != nil && o.MerchantReference != nil { + return true + } + + return false +} + +// SetMerchantReference gets a reference to the given string and assigns it to the MerchantReference field. +func (o *AccountHolderPayoutNotificationContent) SetMerchantReference(v string) { + o.MerchantReference = &v +} + +// GetOriginalPspReference returns the OriginalPspReference field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetOriginalPspReference() string { + if o == nil || o.OriginalPspReference == nil { + var ret string + return ret + } + return *o.OriginalPspReference +} + +// GetOriginalPspReferenceOk returns a tuple with the OriginalPspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetOriginalPspReferenceOk() (*string, bool) { + if o == nil || o.OriginalPspReference == nil { + return nil, false + } + return o.OriginalPspReference, true +} + +// HasOriginalPspReference returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasOriginalPspReference() bool { + if o != nil && o.OriginalPspReference != nil { + return true + } + + return false +} + +// SetOriginalPspReference gets a reference to the given string and assigns it to the OriginalPspReference field. +func (o *AccountHolderPayoutNotificationContent) SetOriginalPspReference(v string) { + o.OriginalPspReference = &v +} + +// GetPayoutAccountCountry returns the PayoutAccountCountry field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetPayoutAccountCountry() string { + if o == nil || o.PayoutAccountCountry == nil { + var ret string + return ret + } + return *o.PayoutAccountCountry +} + +// GetPayoutAccountCountryOk returns a tuple with the PayoutAccountCountry field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetPayoutAccountCountryOk() (*string, bool) { + if o == nil || o.PayoutAccountCountry == nil { + return nil, false + } + return o.PayoutAccountCountry, true +} + +// HasPayoutAccountCountry returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasPayoutAccountCountry() bool { + if o != nil && o.PayoutAccountCountry != nil { + return true + } + + return false +} + +// SetPayoutAccountCountry gets a reference to the given string and assigns it to the PayoutAccountCountry field. +func (o *AccountHolderPayoutNotificationContent) SetPayoutAccountCountry(v string) { + o.PayoutAccountCountry = &v +} + +// GetPayoutAccountNumber returns the PayoutAccountNumber field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetPayoutAccountNumber() string { + if o == nil || o.PayoutAccountNumber == nil { + var ret string + return ret + } + return *o.PayoutAccountNumber +} + +// GetPayoutAccountNumberOk returns a tuple with the PayoutAccountNumber field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetPayoutAccountNumberOk() (*string, bool) { + if o == nil || o.PayoutAccountNumber == nil { + return nil, false + } + return o.PayoutAccountNumber, true +} + +// HasPayoutAccountNumber returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasPayoutAccountNumber() bool { + if o != nil && o.PayoutAccountNumber != nil { + return true + } + + return false +} + +// SetPayoutAccountNumber gets a reference to the given string and assigns it to the PayoutAccountNumber field. +func (o *AccountHolderPayoutNotificationContent) SetPayoutAccountNumber(v string) { + o.PayoutAccountNumber = &v +} + +// GetPayoutBankName returns the PayoutBankName field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetPayoutBankName() string { + if o == nil || o.PayoutBankName == nil { + var ret string + return ret + } + return *o.PayoutBankName +} + +// GetPayoutBankNameOk returns a tuple with the PayoutBankName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetPayoutBankNameOk() (*string, bool) { + if o == nil || o.PayoutBankName == nil { + return nil, false + } + return o.PayoutBankName, true +} + +// HasPayoutBankName returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasPayoutBankName() bool { + if o != nil && o.PayoutBankName != nil { + return true + } + + return false +} + +// SetPayoutBankName gets a reference to the given string and assigns it to the PayoutBankName field. +func (o *AccountHolderPayoutNotificationContent) SetPayoutBankName(v string) { + o.PayoutBankName = &v +} + +// GetPayoutBranchCode returns the PayoutBranchCode field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetPayoutBranchCode() string { + if o == nil || o.PayoutBranchCode == nil { + var ret string + return ret + } + return *o.PayoutBranchCode +} + +// GetPayoutBranchCodeOk returns a tuple with the PayoutBranchCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetPayoutBranchCodeOk() (*string, bool) { + if o == nil || o.PayoutBranchCode == nil { + return nil, false + } + return o.PayoutBranchCode, true +} + +// HasPayoutBranchCode returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasPayoutBranchCode() bool { + if o != nil && o.PayoutBranchCode != nil { + return true + } + + return false +} + +// SetPayoutBranchCode gets a reference to the given string and assigns it to the PayoutBranchCode field. +func (o *AccountHolderPayoutNotificationContent) SetPayoutBranchCode(v string) { + o.PayoutBranchCode = &v +} + +// GetPayoutReference returns the PayoutReference field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetPayoutReference() int64 { + if o == nil || o.PayoutReference == nil { + var ret int64 + return ret + } + return *o.PayoutReference +} + +// GetPayoutReferenceOk returns a tuple with the PayoutReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetPayoutReferenceOk() (*int64, bool) { + if o == nil || o.PayoutReference == nil { + return nil, false + } + return o.PayoutReference, true +} + +// HasPayoutReference returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasPayoutReference() bool { + if o != nil && o.PayoutReference != nil { + return true + } + + return false +} + +// SetPayoutReference gets a reference to the given int64 and assigns it to the PayoutReference field. +func (o *AccountHolderPayoutNotificationContent) SetPayoutReference(v int64) { + o.PayoutReference = &v +} + +// GetPayoutSpeed returns the PayoutSpeed field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetPayoutSpeed() string { + if o == nil || o.PayoutSpeed == nil { + var ret string + return ret + } + return *o.PayoutSpeed +} + +// GetPayoutSpeedOk returns a tuple with the PayoutSpeed field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetPayoutSpeedOk() (*string, bool) { + if o == nil || o.PayoutSpeed == nil { + return nil, false + } + return o.PayoutSpeed, true +} + +// HasPayoutSpeed returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasPayoutSpeed() bool { + if o != nil && o.PayoutSpeed != nil { + return true + } + + return false +} + +// SetPayoutSpeed gets a reference to the given string and assigns it to the PayoutSpeed field. +func (o *AccountHolderPayoutNotificationContent) SetPayoutSpeed(v string) { + o.PayoutSpeed = &v +} + +// GetStatus returns the Status field value if set, zero value otherwise. +func (o *AccountHolderPayoutNotificationContent) GetStatus() OperationStatus { + if o == nil || o.Status == nil { + var ret OperationStatus + return ret + } + return *o.Status +} + +// GetStatusOk returns a tuple with the Status field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderPayoutNotificationContent) GetStatusOk() (*OperationStatus, bool) { + if o == nil || o.Status == nil { + return nil, false + } + return o.Status, true +} + +// HasStatus returns a boolean if a field has been set. +func (o *AccountHolderPayoutNotificationContent) HasStatus() bool { + if o != nil && o.Status != nil { + return true + } + + return false +} + +// SetStatus gets a reference to the given OperationStatus and assigns it to the Status field. +func (o *AccountHolderPayoutNotificationContent) SetStatus(v OperationStatus) { + o.Status = &v +} + +func (o AccountHolderPayoutNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["accountCode"] = o.AccountCode + } + if true { + toSerialize["accountHolderCode"] = o.AccountHolderCode + } + if o.Amounts != nil { + toSerialize["amounts"] = o.Amounts + } + if o.BankAccountDetail != nil { + toSerialize["bankAccountDetail"] = o.BankAccountDetail + } + if o.Description != nil { + toSerialize["description"] = o.Description + } + if o.EstimatedArrivalDate != nil { + toSerialize["estimatedArrivalDate"] = o.EstimatedArrivalDate + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if o.MerchantReference != nil { + toSerialize["merchantReference"] = o.MerchantReference + } + if o.OriginalPspReference != nil { + toSerialize["originalPspReference"] = o.OriginalPspReference + } + if o.PayoutAccountCountry != nil { + toSerialize["payoutAccountCountry"] = o.PayoutAccountCountry + } + if o.PayoutAccountNumber != nil { + toSerialize["payoutAccountNumber"] = o.PayoutAccountNumber + } + if o.PayoutBankName != nil { + toSerialize["payoutBankName"] = o.PayoutBankName + } + if o.PayoutBranchCode != nil { + toSerialize["payoutBranchCode"] = o.PayoutBranchCode + } + if o.PayoutReference != nil { + toSerialize["payoutReference"] = o.PayoutReference + } + if o.PayoutSpeed != nil { + toSerialize["payoutSpeed"] = o.PayoutSpeed + } + if o.Status != nil { + toSerialize["status"] = o.Status + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderPayoutNotificationContent struct { + value *AccountHolderPayoutNotificationContent + isSet bool +} + +func (v NullableAccountHolderPayoutNotificationContent) Get() *AccountHolderPayoutNotificationContent { + return v.value +} + +func (v *NullableAccountHolderPayoutNotificationContent) Set(val *AccountHolderPayoutNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderPayoutNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderPayoutNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderPayoutNotificationContent(val *AccountHolderPayoutNotificationContent) *NullableAccountHolderPayoutNotificationContent { + return &NullableAccountHolderPayoutNotificationContent{value: val, isSet: true} +} + +func (v NullableAccountHolderPayoutNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderPayoutNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_status.go b/src/platformsnotificationevents/model_account_holder_status.go new file mode 100644 index 000000000..8ceafb45f --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_status.go @@ -0,0 +1,256 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// AccountHolderStatus struct for AccountHolderStatus +type AccountHolderStatus struct { + // A list of events scheduled for the account holder. + Events *[]AccountEvent `json:"events,omitempty"` + PayoutState *AccountPayoutState `json:"payoutState,omitempty"` + ProcessingState *AccountProcessingState `json:"processingState,omitempty"` + // The status of the account holder. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`. + Status string `json:"status"` + // The reason why the status was assigned to the account holder. + StatusReason *string `json:"statusReason,omitempty"` +} + +// NewAccountHolderStatus instantiates a new AccountHolderStatus object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderStatus(status string, ) *AccountHolderStatus { + this := AccountHolderStatus{} + this.Status = status + return &this +} + +// NewAccountHolderStatusWithDefaults instantiates a new AccountHolderStatus object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderStatusWithDefaults() *AccountHolderStatus { + this := AccountHolderStatus{} + return &this +} + +// GetEvents returns the Events field value if set, zero value otherwise. +func (o *AccountHolderStatus) GetEvents() []AccountEvent { + if o == nil || o.Events == nil { + var ret []AccountEvent + return ret + } + return *o.Events +} + +// GetEventsOk returns a tuple with the Events field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStatus) GetEventsOk() (*[]AccountEvent, bool) { + if o == nil || o.Events == nil { + return nil, false + } + return o.Events, true +} + +// HasEvents returns a boolean if a field has been set. +func (o *AccountHolderStatus) HasEvents() bool { + if o != nil && o.Events != nil { + return true + } + + return false +} + +// SetEvents gets a reference to the given []AccountEvent and assigns it to the Events field. +func (o *AccountHolderStatus) SetEvents(v []AccountEvent) { + o.Events = &v +} + +// GetPayoutState returns the PayoutState field value if set, zero value otherwise. +func (o *AccountHolderStatus) GetPayoutState() AccountPayoutState { + if o == nil || o.PayoutState == nil { + var ret AccountPayoutState + return ret + } + return *o.PayoutState +} + +// GetPayoutStateOk returns a tuple with the PayoutState field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStatus) GetPayoutStateOk() (*AccountPayoutState, bool) { + if o == nil || o.PayoutState == nil { + return nil, false + } + return o.PayoutState, true +} + +// HasPayoutState returns a boolean if a field has been set. +func (o *AccountHolderStatus) HasPayoutState() bool { + if o != nil && o.PayoutState != nil { + return true + } + + return false +} + +// SetPayoutState gets a reference to the given AccountPayoutState and assigns it to the PayoutState field. +func (o *AccountHolderStatus) SetPayoutState(v AccountPayoutState) { + o.PayoutState = &v +} + +// GetProcessingState returns the ProcessingState field value if set, zero value otherwise. +func (o *AccountHolderStatus) GetProcessingState() AccountProcessingState { + if o == nil || o.ProcessingState == nil { + var ret AccountProcessingState + return ret + } + return *o.ProcessingState +} + +// GetProcessingStateOk returns a tuple with the ProcessingState field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStatus) GetProcessingStateOk() (*AccountProcessingState, bool) { + if o == nil || o.ProcessingState == nil { + return nil, false + } + return o.ProcessingState, true +} + +// HasProcessingState returns a boolean if a field has been set. +func (o *AccountHolderStatus) HasProcessingState() bool { + if o != nil && o.ProcessingState != nil { + return true + } + + return false +} + +// SetProcessingState gets a reference to the given AccountProcessingState and assigns it to the ProcessingState field. +func (o *AccountHolderStatus) SetProcessingState(v AccountProcessingState) { + o.ProcessingState = &v +} + +// GetStatus returns the Status field value +func (o *AccountHolderStatus) GetStatus() string { + if o == nil { + var ret string + return ret + } + + return o.Status +} + +// GetStatusOk returns a tuple with the Status field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStatus) GetStatusOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Status, true +} + +// SetStatus sets field value +func (o *AccountHolderStatus) SetStatus(v string) { + o.Status = v +} + +// GetStatusReason returns the StatusReason field value if set, zero value otherwise. +func (o *AccountHolderStatus) GetStatusReason() string { + if o == nil || o.StatusReason == nil { + var ret string + return ret + } + return *o.StatusReason +} + +// GetStatusReasonOk returns a tuple with the StatusReason field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStatus) GetStatusReasonOk() (*string, bool) { + if o == nil || o.StatusReason == nil { + return nil, false + } + return o.StatusReason, true +} + +// HasStatusReason returns a boolean if a field has been set. +func (o *AccountHolderStatus) HasStatusReason() bool { + if o != nil && o.StatusReason != nil { + return true + } + + return false +} + +// SetStatusReason gets a reference to the given string and assigns it to the StatusReason field. +func (o *AccountHolderStatus) SetStatusReason(v string) { + o.StatusReason = &v +} + +func (o AccountHolderStatus) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Events != nil { + toSerialize["events"] = o.Events + } + if o.PayoutState != nil { + toSerialize["payoutState"] = o.PayoutState + } + if o.ProcessingState != nil { + toSerialize["processingState"] = o.ProcessingState + } + if true { + toSerialize["status"] = o.Status + } + if o.StatusReason != nil { + toSerialize["statusReason"] = o.StatusReason + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderStatus struct { + value *AccountHolderStatus + isSet bool +} + +func (v NullableAccountHolderStatus) Get() *AccountHolderStatus { + return v.value +} + +func (v *NullableAccountHolderStatus) Set(val *AccountHolderStatus) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderStatus) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderStatus) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderStatus(val *AccountHolderStatus) *NullableAccountHolderStatus { + return &NullableAccountHolderStatus{value: val, isSet: true} +} + +func (v NullableAccountHolderStatus) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderStatus) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_status_change_notification.go b/src/platformsnotificationevents/model_account_holder_status_change_notification.go new file mode 100644 index 000000000..964c46e02 --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_status_change_notification.go @@ -0,0 +1,303 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountHolderStatusChangeNotification struct for AccountHolderStatusChangeNotification +type AccountHolderStatusChangeNotification struct { + Content *AccountHolderStatusChangeNotificationContent `json:"content,omitempty"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountHolderStatusChangeNotification instantiates a new AccountHolderStatusChangeNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderStatusChangeNotification(eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountHolderStatusChangeNotification { + this := AccountHolderStatusChangeNotification{} + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountHolderStatusChangeNotificationWithDefaults instantiates a new AccountHolderStatusChangeNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderStatusChangeNotificationWithDefaults() *AccountHolderStatusChangeNotification { + this := AccountHolderStatusChangeNotification{} + return &this +} + +// GetContent returns the Content field value if set, zero value otherwise. +func (o *AccountHolderStatusChangeNotification) GetContent() AccountHolderStatusChangeNotificationContent { + if o == nil || o.Content == nil { + var ret AccountHolderStatusChangeNotificationContent + return ret + } + return *o.Content +} + +// GetContentOk returns a tuple with the Content field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotification) GetContentOk() (*AccountHolderStatusChangeNotificationContent, bool) { + if o == nil || o.Content == nil { + return nil, false + } + return o.Content, true +} + +// HasContent returns a boolean if a field has been set. +func (o *AccountHolderStatusChangeNotification) HasContent() bool { + if o != nil && o.Content != nil { + return true + } + + return false +} + +// SetContent gets a reference to the given AccountHolderStatusChangeNotificationContent and assigns it to the Content field. +func (o *AccountHolderStatusChangeNotification) SetContent(v AccountHolderStatusChangeNotificationContent) { + o.Content = &v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountHolderStatusChangeNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountHolderStatusChangeNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountHolderStatusChangeNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountHolderStatusChangeNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountHolderStatusChangeNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountHolderStatusChangeNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountHolderStatusChangeNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountHolderStatusChangeNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountHolderStatusChangeNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountHolderStatusChangeNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountHolderStatusChangeNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountHolderStatusChangeNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountHolderStatusChangeNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountHolderStatusChangeNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Content != nil { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderStatusChangeNotification struct { + value *AccountHolderStatusChangeNotification + isSet bool +} + +func (v NullableAccountHolderStatusChangeNotification) Get() *AccountHolderStatusChangeNotification { + return v.value +} + +func (v *NullableAccountHolderStatusChangeNotification) Set(val *AccountHolderStatusChangeNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderStatusChangeNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderStatusChangeNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderStatusChangeNotification(val *AccountHolderStatusChangeNotification) *NullableAccountHolderStatusChangeNotification { + return &NullableAccountHolderStatusChangeNotification{value: val, isSet: true} +} + +func (v NullableAccountHolderStatusChangeNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderStatusChangeNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_status_change_notification_content.go b/src/platformsnotificationevents/model_account_holder_status_change_notification_content.go new file mode 100644 index 000000000..b5aff74e0 --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_status_change_notification_content.go @@ -0,0 +1,242 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// AccountHolderStatusChangeNotificationContent struct for AccountHolderStatusChangeNotificationContent +type AccountHolderStatusChangeNotificationContent struct { + // The code of the account holder. + AccountHolderCode string `json:"accountHolderCode"` + // in case the account holder has not been updated, contains account holder fields, that did not pass the validation. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + NewStatus AccountHolderStatus `json:"newStatus"` + OldStatus AccountHolderStatus `json:"oldStatus"` + // The reason for the status change. + Reason *string `json:"reason,omitempty"` +} + +// NewAccountHolderStatusChangeNotificationContent instantiates a new AccountHolderStatusChangeNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderStatusChangeNotificationContent(accountHolderCode string, newStatus AccountHolderStatus, oldStatus AccountHolderStatus, ) *AccountHolderStatusChangeNotificationContent { + this := AccountHolderStatusChangeNotificationContent{} + this.AccountHolderCode = accountHolderCode + this.NewStatus = newStatus + this.OldStatus = oldStatus + return &this +} + +// NewAccountHolderStatusChangeNotificationContentWithDefaults instantiates a new AccountHolderStatusChangeNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderStatusChangeNotificationContentWithDefaults() *AccountHolderStatusChangeNotificationContent { + this := AccountHolderStatusChangeNotificationContent{} + return &this +} + +// GetAccountHolderCode returns the AccountHolderCode field value +func (o *AccountHolderStatusChangeNotificationContent) GetAccountHolderCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountHolderCode +} + +// GetAccountHolderCodeOk returns a tuple with the AccountHolderCode field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotificationContent) GetAccountHolderCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountHolderCode, true +} + +// SetAccountHolderCode sets field value +func (o *AccountHolderStatusChangeNotificationContent) SetAccountHolderCode(v string) { + o.AccountHolderCode = v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *AccountHolderStatusChangeNotificationContent) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotificationContent) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *AccountHolderStatusChangeNotificationContent) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *AccountHolderStatusChangeNotificationContent) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetNewStatus returns the NewStatus field value +func (o *AccountHolderStatusChangeNotificationContent) GetNewStatus() AccountHolderStatus { + if o == nil { + var ret AccountHolderStatus + return ret + } + + return o.NewStatus +} + +// GetNewStatusOk returns a tuple with the NewStatus field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotificationContent) GetNewStatusOk() (*AccountHolderStatus, bool) { + if o == nil { + return nil, false + } + return &o.NewStatus, true +} + +// SetNewStatus sets field value +func (o *AccountHolderStatusChangeNotificationContent) SetNewStatus(v AccountHolderStatus) { + o.NewStatus = v +} + +// GetOldStatus returns the OldStatus field value +func (o *AccountHolderStatusChangeNotificationContent) GetOldStatus() AccountHolderStatus { + if o == nil { + var ret AccountHolderStatus + return ret + } + + return o.OldStatus +} + +// GetOldStatusOk returns a tuple with the OldStatus field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotificationContent) GetOldStatusOk() (*AccountHolderStatus, bool) { + if o == nil { + return nil, false + } + return &o.OldStatus, true +} + +// SetOldStatus sets field value +func (o *AccountHolderStatusChangeNotificationContent) SetOldStatus(v AccountHolderStatus) { + o.OldStatus = v +} + +// GetReason returns the Reason field value if set, zero value otherwise. +func (o *AccountHolderStatusChangeNotificationContent) GetReason() string { + if o == nil || o.Reason == nil { + var ret string + return ret + } + return *o.Reason +} + +// GetReasonOk returns a tuple with the Reason field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStatusChangeNotificationContent) GetReasonOk() (*string, bool) { + if o == nil || o.Reason == nil { + return nil, false + } + return o.Reason, true +} + +// HasReason returns a boolean if a field has been set. +func (o *AccountHolderStatusChangeNotificationContent) HasReason() bool { + if o != nil && o.Reason != nil { + return true + } + + return false +} + +// SetReason gets a reference to the given string and assigns it to the Reason field. +func (o *AccountHolderStatusChangeNotificationContent) SetReason(v string) { + o.Reason = &v +} + +func (o AccountHolderStatusChangeNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["accountHolderCode"] = o.AccountHolderCode + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if true { + toSerialize["newStatus"] = o.NewStatus + } + if true { + toSerialize["oldStatus"] = o.OldStatus + } + if o.Reason != nil { + toSerialize["reason"] = o.Reason + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderStatusChangeNotificationContent struct { + value *AccountHolderStatusChangeNotificationContent + isSet bool +} + +func (v NullableAccountHolderStatusChangeNotificationContent) Get() *AccountHolderStatusChangeNotificationContent { + return v.value +} + +func (v *NullableAccountHolderStatusChangeNotificationContent) Set(val *AccountHolderStatusChangeNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderStatusChangeNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderStatusChangeNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderStatusChangeNotificationContent(val *AccountHolderStatusChangeNotificationContent) *NullableAccountHolderStatusChangeNotificationContent { + return &NullableAccountHolderStatusChangeNotificationContent{value: val, isSet: true} +} + +func (v NullableAccountHolderStatusChangeNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderStatusChangeNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_store_status_change_notification.go b/src/platformsnotificationevents/model_account_holder_store_status_change_notification.go new file mode 100644 index 000000000..c74e78911 --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_store_status_change_notification.go @@ -0,0 +1,303 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountHolderStoreStatusChangeNotification struct for AccountHolderStoreStatusChangeNotification +type AccountHolderStoreStatusChangeNotification struct { + Content *AccountHolderStoreStatusChangeNotificationContent `json:"content,omitempty"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountHolderStoreStatusChangeNotification instantiates a new AccountHolderStoreStatusChangeNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderStoreStatusChangeNotification(eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountHolderStoreStatusChangeNotification { + this := AccountHolderStoreStatusChangeNotification{} + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountHolderStoreStatusChangeNotificationWithDefaults instantiates a new AccountHolderStoreStatusChangeNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderStoreStatusChangeNotificationWithDefaults() *AccountHolderStoreStatusChangeNotification { + this := AccountHolderStoreStatusChangeNotification{} + return &this +} + +// GetContent returns the Content field value if set, zero value otherwise. +func (o *AccountHolderStoreStatusChangeNotification) GetContent() AccountHolderStoreStatusChangeNotificationContent { + if o == nil || o.Content == nil { + var ret AccountHolderStoreStatusChangeNotificationContent + return ret + } + return *o.Content +} + +// GetContentOk returns a tuple with the Content field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotification) GetContentOk() (*AccountHolderStoreStatusChangeNotificationContent, bool) { + if o == nil || o.Content == nil { + return nil, false + } + return o.Content, true +} + +// HasContent returns a boolean if a field has been set. +func (o *AccountHolderStoreStatusChangeNotification) HasContent() bool { + if o != nil && o.Content != nil { + return true + } + + return false +} + +// SetContent gets a reference to the given AccountHolderStoreStatusChangeNotificationContent and assigns it to the Content field. +func (o *AccountHolderStoreStatusChangeNotification) SetContent(v AccountHolderStoreStatusChangeNotificationContent) { + o.Content = &v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountHolderStoreStatusChangeNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountHolderStoreStatusChangeNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountHolderStoreStatusChangeNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountHolderStoreStatusChangeNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountHolderStoreStatusChangeNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountHolderStoreStatusChangeNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountHolderStoreStatusChangeNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountHolderStoreStatusChangeNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountHolderStoreStatusChangeNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountHolderStoreStatusChangeNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountHolderStoreStatusChangeNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountHolderStoreStatusChangeNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountHolderStoreStatusChangeNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountHolderStoreStatusChangeNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Content != nil { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderStoreStatusChangeNotification struct { + value *AccountHolderStoreStatusChangeNotification + isSet bool +} + +func (v NullableAccountHolderStoreStatusChangeNotification) Get() *AccountHolderStoreStatusChangeNotification { + return v.value +} + +func (v *NullableAccountHolderStoreStatusChangeNotification) Set(val *AccountHolderStoreStatusChangeNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderStoreStatusChangeNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderStoreStatusChangeNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderStoreStatusChangeNotification(val *AccountHolderStoreStatusChangeNotification) *NullableAccountHolderStoreStatusChangeNotification { + return &NullableAccountHolderStoreStatusChangeNotification{value: val, isSet: true} +} + +func (v NullableAccountHolderStoreStatusChangeNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderStoreStatusChangeNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_store_status_change_notification_content.go b/src/platformsnotificationevents/model_account_holder_store_status_change_notification_content.go new file mode 100644 index 000000000..46e34fa07 --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_store_status_change_notification_content.go @@ -0,0 +1,304 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// AccountHolderStoreStatusChangeNotificationContent struct for AccountHolderStoreStatusChangeNotificationContent +type AccountHolderStoreStatusChangeNotificationContent struct { + // The code of the account holder. + AccountHolderCode string `json:"accountHolderCode"` + // In case the store status has not been updated, contains fields that did not pass the validation. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + // The new status of the account holder. + NewStatus string `json:"newStatus"` + // The former status of the account holder. + OldStatus string `json:"oldStatus"` + // The reason for the status change. + Reason *string `json:"reason,omitempty"` + // Alphanumeric identifier of the store. + Store string `json:"store"` + // Store store reference. + StoreReference string `json:"storeReference"` +} + +// NewAccountHolderStoreStatusChangeNotificationContent instantiates a new AccountHolderStoreStatusChangeNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderStoreStatusChangeNotificationContent(accountHolderCode string, newStatus string, oldStatus string, store string, storeReference string, ) *AccountHolderStoreStatusChangeNotificationContent { + this := AccountHolderStoreStatusChangeNotificationContent{} + this.AccountHolderCode = accountHolderCode + this.NewStatus = newStatus + this.OldStatus = oldStatus + this.Store = store + this.StoreReference = storeReference + return &this +} + +// NewAccountHolderStoreStatusChangeNotificationContentWithDefaults instantiates a new AccountHolderStoreStatusChangeNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderStoreStatusChangeNotificationContentWithDefaults() *AccountHolderStoreStatusChangeNotificationContent { + this := AccountHolderStoreStatusChangeNotificationContent{} + return &this +} + +// GetAccountHolderCode returns the AccountHolderCode field value +func (o *AccountHolderStoreStatusChangeNotificationContent) GetAccountHolderCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountHolderCode +} + +// GetAccountHolderCodeOk returns a tuple with the AccountHolderCode field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotificationContent) GetAccountHolderCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountHolderCode, true +} + +// SetAccountHolderCode sets field value +func (o *AccountHolderStoreStatusChangeNotificationContent) SetAccountHolderCode(v string) { + o.AccountHolderCode = v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *AccountHolderStoreStatusChangeNotificationContent) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotificationContent) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *AccountHolderStoreStatusChangeNotificationContent) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *AccountHolderStoreStatusChangeNotificationContent) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetNewStatus returns the NewStatus field value +func (o *AccountHolderStoreStatusChangeNotificationContent) GetNewStatus() string { + if o == nil { + var ret string + return ret + } + + return o.NewStatus +} + +// GetNewStatusOk returns a tuple with the NewStatus field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotificationContent) GetNewStatusOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.NewStatus, true +} + +// SetNewStatus sets field value +func (o *AccountHolderStoreStatusChangeNotificationContent) SetNewStatus(v string) { + o.NewStatus = v +} + +// GetOldStatus returns the OldStatus field value +func (o *AccountHolderStoreStatusChangeNotificationContent) GetOldStatus() string { + if o == nil { + var ret string + return ret + } + + return o.OldStatus +} + +// GetOldStatusOk returns a tuple with the OldStatus field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotificationContent) GetOldStatusOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.OldStatus, true +} + +// SetOldStatus sets field value +func (o *AccountHolderStoreStatusChangeNotificationContent) SetOldStatus(v string) { + o.OldStatus = v +} + +// GetReason returns the Reason field value if set, zero value otherwise. +func (o *AccountHolderStoreStatusChangeNotificationContent) GetReason() string { + if o == nil || o.Reason == nil { + var ret string + return ret + } + return *o.Reason +} + +// GetReasonOk returns a tuple with the Reason field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotificationContent) GetReasonOk() (*string, bool) { + if o == nil || o.Reason == nil { + return nil, false + } + return o.Reason, true +} + +// HasReason returns a boolean if a field has been set. +func (o *AccountHolderStoreStatusChangeNotificationContent) HasReason() bool { + if o != nil && o.Reason != nil { + return true + } + + return false +} + +// SetReason gets a reference to the given string and assigns it to the Reason field. +func (o *AccountHolderStoreStatusChangeNotificationContent) SetReason(v string) { + o.Reason = &v +} + +// GetStore returns the Store field value +func (o *AccountHolderStoreStatusChangeNotificationContent) GetStore() string { + if o == nil { + var ret string + return ret + } + + return o.Store +} + +// GetStoreOk returns a tuple with the Store field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotificationContent) GetStoreOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Store, true +} + +// SetStore sets field value +func (o *AccountHolderStoreStatusChangeNotificationContent) SetStore(v string) { + o.Store = v +} + +// GetStoreReference returns the StoreReference field value +func (o *AccountHolderStoreStatusChangeNotificationContent) GetStoreReference() string { + if o == nil { + var ret string + return ret + } + + return o.StoreReference +} + +// GetStoreReferenceOk returns a tuple with the StoreReference field value +// and a boolean to check if the value has been set. +func (o *AccountHolderStoreStatusChangeNotificationContent) GetStoreReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.StoreReference, true +} + +// SetStoreReference sets field value +func (o *AccountHolderStoreStatusChangeNotificationContent) SetStoreReference(v string) { + o.StoreReference = v +} + +func (o AccountHolderStoreStatusChangeNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["accountHolderCode"] = o.AccountHolderCode + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if true { + toSerialize["newStatus"] = o.NewStatus + } + if true { + toSerialize["oldStatus"] = o.OldStatus + } + if o.Reason != nil { + toSerialize["reason"] = o.Reason + } + if true { + toSerialize["store"] = o.Store + } + if true { + toSerialize["storeReference"] = o.StoreReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderStoreStatusChangeNotificationContent struct { + value *AccountHolderStoreStatusChangeNotificationContent + isSet bool +} + +func (v NullableAccountHolderStoreStatusChangeNotificationContent) Get() *AccountHolderStoreStatusChangeNotificationContent { + return v.value +} + +func (v *NullableAccountHolderStoreStatusChangeNotificationContent) Set(val *AccountHolderStoreStatusChangeNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderStoreStatusChangeNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderStoreStatusChangeNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderStoreStatusChangeNotificationContent(val *AccountHolderStoreStatusChangeNotificationContent) *NullableAccountHolderStoreStatusChangeNotificationContent { + return &NullableAccountHolderStoreStatusChangeNotificationContent{value: val, isSet: true} +} + +func (v NullableAccountHolderStoreStatusChangeNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderStoreStatusChangeNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_upcoming_deadline_notification.go b/src/platformsnotificationevents/model_account_holder_upcoming_deadline_notification.go new file mode 100644 index 000000000..d23ab751e --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_upcoming_deadline_notification.go @@ -0,0 +1,303 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountHolderUpcomingDeadlineNotification struct for AccountHolderUpcomingDeadlineNotification +type AccountHolderUpcomingDeadlineNotification struct { + Content *AccountHolderUpcomingDeadlineNotificationContent `json:"content,omitempty"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountHolderUpcomingDeadlineNotification instantiates a new AccountHolderUpcomingDeadlineNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderUpcomingDeadlineNotification(eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountHolderUpcomingDeadlineNotification { + this := AccountHolderUpcomingDeadlineNotification{} + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountHolderUpcomingDeadlineNotificationWithDefaults instantiates a new AccountHolderUpcomingDeadlineNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderUpcomingDeadlineNotificationWithDefaults() *AccountHolderUpcomingDeadlineNotification { + this := AccountHolderUpcomingDeadlineNotification{} + return &this +} + +// GetContent returns the Content field value if set, zero value otherwise. +func (o *AccountHolderUpcomingDeadlineNotification) GetContent() AccountHolderUpcomingDeadlineNotificationContent { + if o == nil || o.Content == nil { + var ret AccountHolderUpcomingDeadlineNotificationContent + return ret + } + return *o.Content +} + +// GetContentOk returns a tuple with the Content field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotification) GetContentOk() (*AccountHolderUpcomingDeadlineNotificationContent, bool) { + if o == nil || o.Content == nil { + return nil, false + } + return o.Content, true +} + +// HasContent returns a boolean if a field has been set. +func (o *AccountHolderUpcomingDeadlineNotification) HasContent() bool { + if o != nil && o.Content != nil { + return true + } + + return false +} + +// SetContent gets a reference to the given AccountHolderUpcomingDeadlineNotificationContent and assigns it to the Content field. +func (o *AccountHolderUpcomingDeadlineNotification) SetContent(v AccountHolderUpcomingDeadlineNotificationContent) { + o.Content = &v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountHolderUpcomingDeadlineNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountHolderUpcomingDeadlineNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountHolderUpcomingDeadlineNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountHolderUpcomingDeadlineNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountHolderUpcomingDeadlineNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountHolderUpcomingDeadlineNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountHolderUpcomingDeadlineNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountHolderUpcomingDeadlineNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountHolderUpcomingDeadlineNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountHolderUpcomingDeadlineNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountHolderUpcomingDeadlineNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountHolderUpcomingDeadlineNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountHolderUpcomingDeadlineNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountHolderUpcomingDeadlineNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Content != nil { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderUpcomingDeadlineNotification struct { + value *AccountHolderUpcomingDeadlineNotification + isSet bool +} + +func (v NullableAccountHolderUpcomingDeadlineNotification) Get() *AccountHolderUpcomingDeadlineNotification { + return v.value +} + +func (v *NullableAccountHolderUpcomingDeadlineNotification) Set(val *AccountHolderUpcomingDeadlineNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderUpcomingDeadlineNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderUpcomingDeadlineNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderUpcomingDeadlineNotification(val *AccountHolderUpcomingDeadlineNotification) *NullableAccountHolderUpcomingDeadlineNotification { + return &NullableAccountHolderUpcomingDeadlineNotification{value: val, isSet: true} +} + +func (v NullableAccountHolderUpcomingDeadlineNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderUpcomingDeadlineNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_upcoming_deadline_notification_content.go b/src/platformsnotificationevents/model_account_holder_upcoming_deadline_notification_content.go new file mode 100644 index 000000000..a2ce192ba --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_upcoming_deadline_notification_content.go @@ -0,0 +1,227 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// AccountHolderUpcomingDeadlineNotificationContent struct for AccountHolderUpcomingDeadlineNotificationContent +type AccountHolderUpcomingDeadlineNotificationContent struct { + // The code of the account holder whom the event refers to. + AccountHolderCode *string `json:"accountHolderCode,omitempty"` + // The event name that will be trigger if no action is taken. + Event *string `json:"event,omitempty"` + ExecutionDate *LocalDate `json:"executionDate,omitempty"` + // The reason that leads to scheduling of the event. + Reason *string `json:"reason,omitempty"` +} + +// NewAccountHolderUpcomingDeadlineNotificationContent instantiates a new AccountHolderUpcomingDeadlineNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderUpcomingDeadlineNotificationContent() *AccountHolderUpcomingDeadlineNotificationContent { + this := AccountHolderUpcomingDeadlineNotificationContent{} + return &this +} + +// NewAccountHolderUpcomingDeadlineNotificationContentWithDefaults instantiates a new AccountHolderUpcomingDeadlineNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderUpcomingDeadlineNotificationContentWithDefaults() *AccountHolderUpcomingDeadlineNotificationContent { + this := AccountHolderUpcomingDeadlineNotificationContent{} + return &this +} + +// GetAccountHolderCode returns the AccountHolderCode field value if set, zero value otherwise. +func (o *AccountHolderUpcomingDeadlineNotificationContent) GetAccountHolderCode() string { + if o == nil || o.AccountHolderCode == nil { + var ret string + return ret + } + return *o.AccountHolderCode +} + +// GetAccountHolderCodeOk returns a tuple with the AccountHolderCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotificationContent) GetAccountHolderCodeOk() (*string, bool) { + if o == nil || o.AccountHolderCode == nil { + return nil, false + } + return o.AccountHolderCode, true +} + +// HasAccountHolderCode returns a boolean if a field has been set. +func (o *AccountHolderUpcomingDeadlineNotificationContent) HasAccountHolderCode() bool { + if o != nil && o.AccountHolderCode != nil { + return true + } + + return false +} + +// SetAccountHolderCode gets a reference to the given string and assigns it to the AccountHolderCode field. +func (o *AccountHolderUpcomingDeadlineNotificationContent) SetAccountHolderCode(v string) { + o.AccountHolderCode = &v +} + +// GetEvent returns the Event field value if set, zero value otherwise. +func (o *AccountHolderUpcomingDeadlineNotificationContent) GetEvent() string { + if o == nil || o.Event == nil { + var ret string + return ret + } + return *o.Event +} + +// GetEventOk returns a tuple with the Event field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotificationContent) GetEventOk() (*string, bool) { + if o == nil || o.Event == nil { + return nil, false + } + return o.Event, true +} + +// HasEvent returns a boolean if a field has been set. +func (o *AccountHolderUpcomingDeadlineNotificationContent) HasEvent() bool { + if o != nil && o.Event != nil { + return true + } + + return false +} + +// SetEvent gets a reference to the given string and assigns it to the Event field. +func (o *AccountHolderUpcomingDeadlineNotificationContent) SetEvent(v string) { + o.Event = &v +} + +// GetExecutionDate returns the ExecutionDate field value if set, zero value otherwise. +func (o *AccountHolderUpcomingDeadlineNotificationContent) GetExecutionDate() LocalDate { + if o == nil || o.ExecutionDate == nil { + var ret LocalDate + return ret + } + return *o.ExecutionDate +} + +// GetExecutionDateOk returns a tuple with the ExecutionDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotificationContent) GetExecutionDateOk() (*LocalDate, bool) { + if o == nil || o.ExecutionDate == nil { + return nil, false + } + return o.ExecutionDate, true +} + +// HasExecutionDate returns a boolean if a field has been set. +func (o *AccountHolderUpcomingDeadlineNotificationContent) HasExecutionDate() bool { + if o != nil && o.ExecutionDate != nil { + return true + } + + return false +} + +// SetExecutionDate gets a reference to the given LocalDate and assigns it to the ExecutionDate field. +func (o *AccountHolderUpcomingDeadlineNotificationContent) SetExecutionDate(v LocalDate) { + o.ExecutionDate = &v +} + +// GetReason returns the Reason field value if set, zero value otherwise. +func (o *AccountHolderUpcomingDeadlineNotificationContent) GetReason() string { + if o == nil || o.Reason == nil { + var ret string + return ret + } + return *o.Reason +} + +// GetReasonOk returns a tuple with the Reason field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderUpcomingDeadlineNotificationContent) GetReasonOk() (*string, bool) { + if o == nil || o.Reason == nil { + return nil, false + } + return o.Reason, true +} + +// HasReason returns a boolean if a field has been set. +func (o *AccountHolderUpcomingDeadlineNotificationContent) HasReason() bool { + if o != nil && o.Reason != nil { + return true + } + + return false +} + +// SetReason gets a reference to the given string and assigns it to the Reason field. +func (o *AccountHolderUpcomingDeadlineNotificationContent) SetReason(v string) { + o.Reason = &v +} + +func (o AccountHolderUpcomingDeadlineNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.AccountHolderCode != nil { + toSerialize["accountHolderCode"] = o.AccountHolderCode + } + if o.Event != nil { + toSerialize["event"] = o.Event + } + if o.ExecutionDate != nil { + toSerialize["executionDate"] = o.ExecutionDate + } + if o.Reason != nil { + toSerialize["reason"] = o.Reason + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderUpcomingDeadlineNotificationContent struct { + value *AccountHolderUpcomingDeadlineNotificationContent + isSet bool +} + +func (v NullableAccountHolderUpcomingDeadlineNotificationContent) Get() *AccountHolderUpcomingDeadlineNotificationContent { + return v.value +} + +func (v *NullableAccountHolderUpcomingDeadlineNotificationContent) Set(val *AccountHolderUpcomingDeadlineNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderUpcomingDeadlineNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderUpcomingDeadlineNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderUpcomingDeadlineNotificationContent(val *AccountHolderUpcomingDeadlineNotificationContent) *NullableAccountHolderUpcomingDeadlineNotificationContent { + return &NullableAccountHolderUpcomingDeadlineNotificationContent{value: val, isSet: true} +} + +func (v NullableAccountHolderUpcomingDeadlineNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderUpcomingDeadlineNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_update_notification.go b/src/platformsnotificationevents/model_account_holder_update_notification.go new file mode 100644 index 000000000..895df1747 --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_update_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountHolderUpdateNotification struct for AccountHolderUpdateNotification +type AccountHolderUpdateNotification struct { + Content UpdateAccountHolderResponse `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountHolderUpdateNotification instantiates a new AccountHolderUpdateNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderUpdateNotification(content UpdateAccountHolderResponse, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountHolderUpdateNotification { + this := AccountHolderUpdateNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountHolderUpdateNotificationWithDefaults instantiates a new AccountHolderUpdateNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderUpdateNotificationWithDefaults() *AccountHolderUpdateNotification { + this := AccountHolderUpdateNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *AccountHolderUpdateNotification) GetContent() UpdateAccountHolderResponse { + if o == nil { + var ret UpdateAccountHolderResponse + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpdateNotification) GetContentOk() (*UpdateAccountHolderResponse, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *AccountHolderUpdateNotification) SetContent(v UpdateAccountHolderResponse) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountHolderUpdateNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderUpdateNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountHolderUpdateNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountHolderUpdateNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountHolderUpdateNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpdateNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountHolderUpdateNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountHolderUpdateNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpdateNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountHolderUpdateNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountHolderUpdateNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpdateNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountHolderUpdateNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountHolderUpdateNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpdateNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountHolderUpdateNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountHolderUpdateNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountHolderUpdateNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountHolderUpdateNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountHolderUpdateNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderUpdateNotification struct { + value *AccountHolderUpdateNotification + isSet bool +} + +func (v NullableAccountHolderUpdateNotification) Get() *AccountHolderUpdateNotification { + return v.value +} + +func (v *NullableAccountHolderUpdateNotification) Set(val *AccountHolderUpdateNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderUpdateNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderUpdateNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderUpdateNotification(val *AccountHolderUpdateNotification) *NullableAccountHolderUpdateNotification { + return &NullableAccountHolderUpdateNotification{value: val, isSet: true} +} + +func (v NullableAccountHolderUpdateNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderUpdateNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_verification_notification.go b/src/platformsnotificationevents/model_account_holder_verification_notification.go new file mode 100644 index 000000000..8c1731401 --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_verification_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountHolderVerificationNotification struct for AccountHolderVerificationNotification +type AccountHolderVerificationNotification struct { + Content AccountHolderVerificationNotificationContent `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountHolderVerificationNotification instantiates a new AccountHolderVerificationNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderVerificationNotification(content AccountHolderVerificationNotificationContent, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountHolderVerificationNotification { + this := AccountHolderVerificationNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountHolderVerificationNotificationWithDefaults instantiates a new AccountHolderVerificationNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderVerificationNotificationWithDefaults() *AccountHolderVerificationNotification { + this := AccountHolderVerificationNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *AccountHolderVerificationNotification) GetContent() AccountHolderVerificationNotificationContent { + if o == nil { + var ret AccountHolderVerificationNotificationContent + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotification) GetContentOk() (*AccountHolderVerificationNotificationContent, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *AccountHolderVerificationNotification) SetContent(v AccountHolderVerificationNotificationContent) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountHolderVerificationNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountHolderVerificationNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountHolderVerificationNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountHolderVerificationNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountHolderVerificationNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountHolderVerificationNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountHolderVerificationNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountHolderVerificationNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountHolderVerificationNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountHolderVerificationNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountHolderVerificationNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountHolderVerificationNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountHolderVerificationNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountHolderVerificationNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderVerificationNotification struct { + value *AccountHolderVerificationNotification + isSet bool +} + +func (v NullableAccountHolderVerificationNotification) Get() *AccountHolderVerificationNotification { + return v.value +} + +func (v *NullableAccountHolderVerificationNotification) Set(val *AccountHolderVerificationNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderVerificationNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderVerificationNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderVerificationNotification(val *AccountHolderVerificationNotification) *NullableAccountHolderVerificationNotification { + return &NullableAccountHolderVerificationNotification{value: val, isSet: true} +} + +func (v NullableAccountHolderVerificationNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderVerificationNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_holder_verification_notification_content.go b/src/platformsnotificationevents/model_account_holder_verification_notification_content.go new file mode 100644 index 000000000..8cda9bab3 --- /dev/null +++ b/src/platformsnotificationevents/model_account_holder_verification_notification_content.go @@ -0,0 +1,220 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// AccountHolderVerificationNotificationContent struct for AccountHolderVerificationNotificationContent +type AccountHolderVerificationNotificationContent struct { + // The code of the account holder. + AccountHolderCode string `json:"accountHolderCode"` + KycCheckStatusData *KYCCheckStatusData `json:"kycCheckStatusData,omitempty"` + // The unique code of the payout method that has been verified. + PayoutMethodCode *string `json:"payoutMethodCode,omitempty"` + // The code of the shareholder that has been verified. + ShareholderCode *string `json:"shareholderCode,omitempty"` +} + +// NewAccountHolderVerificationNotificationContent instantiates a new AccountHolderVerificationNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountHolderVerificationNotificationContent(accountHolderCode string, ) *AccountHolderVerificationNotificationContent { + this := AccountHolderVerificationNotificationContent{} + this.AccountHolderCode = accountHolderCode + return &this +} + +// NewAccountHolderVerificationNotificationContentWithDefaults instantiates a new AccountHolderVerificationNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountHolderVerificationNotificationContentWithDefaults() *AccountHolderVerificationNotificationContent { + this := AccountHolderVerificationNotificationContent{} + return &this +} + +// GetAccountHolderCode returns the AccountHolderCode field value +func (o *AccountHolderVerificationNotificationContent) GetAccountHolderCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountHolderCode +} + +// GetAccountHolderCodeOk returns a tuple with the AccountHolderCode field value +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotificationContent) GetAccountHolderCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountHolderCode, true +} + +// SetAccountHolderCode sets field value +func (o *AccountHolderVerificationNotificationContent) SetAccountHolderCode(v string) { + o.AccountHolderCode = v +} + +// GetKycCheckStatusData returns the KycCheckStatusData field value if set, zero value otherwise. +func (o *AccountHolderVerificationNotificationContent) GetKycCheckStatusData() KYCCheckStatusData { + if o == nil || o.KycCheckStatusData == nil { + var ret KYCCheckStatusData + return ret + } + return *o.KycCheckStatusData +} + +// GetKycCheckStatusDataOk returns a tuple with the KycCheckStatusData field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotificationContent) GetKycCheckStatusDataOk() (*KYCCheckStatusData, bool) { + if o == nil || o.KycCheckStatusData == nil { + return nil, false + } + return o.KycCheckStatusData, true +} + +// HasKycCheckStatusData returns a boolean if a field has been set. +func (o *AccountHolderVerificationNotificationContent) HasKycCheckStatusData() bool { + if o != nil && o.KycCheckStatusData != nil { + return true + } + + return false +} + +// SetKycCheckStatusData gets a reference to the given KYCCheckStatusData and assigns it to the KycCheckStatusData field. +func (o *AccountHolderVerificationNotificationContent) SetKycCheckStatusData(v KYCCheckStatusData) { + o.KycCheckStatusData = &v +} + +// GetPayoutMethodCode returns the PayoutMethodCode field value if set, zero value otherwise. +func (o *AccountHolderVerificationNotificationContent) GetPayoutMethodCode() string { + if o == nil || o.PayoutMethodCode == nil { + var ret string + return ret + } + return *o.PayoutMethodCode +} + +// GetPayoutMethodCodeOk returns a tuple with the PayoutMethodCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotificationContent) GetPayoutMethodCodeOk() (*string, bool) { + if o == nil || o.PayoutMethodCode == nil { + return nil, false + } + return o.PayoutMethodCode, true +} + +// HasPayoutMethodCode returns a boolean if a field has been set. +func (o *AccountHolderVerificationNotificationContent) HasPayoutMethodCode() bool { + if o != nil && o.PayoutMethodCode != nil { + return true + } + + return false +} + +// SetPayoutMethodCode gets a reference to the given string and assigns it to the PayoutMethodCode field. +func (o *AccountHolderVerificationNotificationContent) SetPayoutMethodCode(v string) { + o.PayoutMethodCode = &v +} + +// GetShareholderCode returns the ShareholderCode field value if set, zero value otherwise. +func (o *AccountHolderVerificationNotificationContent) GetShareholderCode() string { + if o == nil || o.ShareholderCode == nil { + var ret string + return ret + } + return *o.ShareholderCode +} + +// GetShareholderCodeOk returns a tuple with the ShareholderCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountHolderVerificationNotificationContent) GetShareholderCodeOk() (*string, bool) { + if o == nil || o.ShareholderCode == nil { + return nil, false + } + return o.ShareholderCode, true +} + +// HasShareholderCode returns a boolean if a field has been set. +func (o *AccountHolderVerificationNotificationContent) HasShareholderCode() bool { + if o != nil && o.ShareholderCode != nil { + return true + } + + return false +} + +// SetShareholderCode gets a reference to the given string and assigns it to the ShareholderCode field. +func (o *AccountHolderVerificationNotificationContent) SetShareholderCode(v string) { + o.ShareholderCode = &v +} + +func (o AccountHolderVerificationNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["accountHolderCode"] = o.AccountHolderCode + } + if o.KycCheckStatusData != nil { + toSerialize["kycCheckStatusData"] = o.KycCheckStatusData + } + if o.PayoutMethodCode != nil { + toSerialize["payoutMethodCode"] = o.PayoutMethodCode + } + if o.ShareholderCode != nil { + toSerialize["shareholderCode"] = o.ShareholderCode + } + return json.Marshal(toSerialize) +} + +type NullableAccountHolderVerificationNotificationContent struct { + value *AccountHolderVerificationNotificationContent + isSet bool +} + +func (v NullableAccountHolderVerificationNotificationContent) Get() *AccountHolderVerificationNotificationContent { + return v.value +} + +func (v *NullableAccountHolderVerificationNotificationContent) Set(val *AccountHolderVerificationNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableAccountHolderVerificationNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountHolderVerificationNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountHolderVerificationNotificationContent(val *AccountHolderVerificationNotificationContent) *NullableAccountHolderVerificationNotificationContent { + return &NullableAccountHolderVerificationNotificationContent{value: val, isSet: true} +} + +func (v NullableAccountHolderVerificationNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountHolderVerificationNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_payout_state.go b/src/platformsnotificationevents/model_account_payout_state.go new file mode 100644 index 000000000..55eb1e99e --- /dev/null +++ b/src/platformsnotificationevents/model_account_payout_state.go @@ -0,0 +1,301 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// AccountPayoutState struct for AccountPayoutState +type AccountPayoutState struct { + // Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts. + AllowPayout *bool `json:"allowPayout,omitempty"` + // The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the `disabled` field is true, this field can be used to explain why. + DisableReason *string `json:"disableReason,omitempty"` + // Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, `allowPayout` will be false and no payouts will be permitted for any of the account holder's accounts. If this field is false, `allowPayout` may or may not be enabled, depending on other factors. + Disabled *bool `json:"disabled,omitempty"` + // The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen. + NotAllowedReason *string `json:"notAllowedReason,omitempty"` + PayoutLimit *Amount `json:"payoutLimit,omitempty"` + // The payout tier that the account holder occupies. + TierNumber *int32 `json:"tierNumber,omitempty"` +} + +// NewAccountPayoutState instantiates a new AccountPayoutState object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountPayoutState() *AccountPayoutState { + this := AccountPayoutState{} + return &this +} + +// NewAccountPayoutStateWithDefaults instantiates a new AccountPayoutState object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountPayoutStateWithDefaults() *AccountPayoutState { + this := AccountPayoutState{} + return &this +} + +// GetAllowPayout returns the AllowPayout field value if set, zero value otherwise. +func (o *AccountPayoutState) GetAllowPayout() bool { + if o == nil || o.AllowPayout == nil { + var ret bool + return ret + } + return *o.AllowPayout +} + +// GetAllowPayoutOk returns a tuple with the AllowPayout field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountPayoutState) GetAllowPayoutOk() (*bool, bool) { + if o == nil || o.AllowPayout == nil { + return nil, false + } + return o.AllowPayout, true +} + +// HasAllowPayout returns a boolean if a field has been set. +func (o *AccountPayoutState) HasAllowPayout() bool { + if o != nil && o.AllowPayout != nil { + return true + } + + return false +} + +// SetAllowPayout gets a reference to the given bool and assigns it to the AllowPayout field. +func (o *AccountPayoutState) SetAllowPayout(v bool) { + o.AllowPayout = &v +} + +// GetDisableReason returns the DisableReason field value if set, zero value otherwise. +func (o *AccountPayoutState) GetDisableReason() string { + if o == nil || o.DisableReason == nil { + var ret string + return ret + } + return *o.DisableReason +} + +// GetDisableReasonOk returns a tuple with the DisableReason field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountPayoutState) GetDisableReasonOk() (*string, bool) { + if o == nil || o.DisableReason == nil { + return nil, false + } + return o.DisableReason, true +} + +// HasDisableReason returns a boolean if a field has been set. +func (o *AccountPayoutState) HasDisableReason() bool { + if o != nil && o.DisableReason != nil { + return true + } + + return false +} + +// SetDisableReason gets a reference to the given string and assigns it to the DisableReason field. +func (o *AccountPayoutState) SetDisableReason(v string) { + o.DisableReason = &v +} + +// GetDisabled returns the Disabled field value if set, zero value otherwise. +func (o *AccountPayoutState) GetDisabled() bool { + if o == nil || o.Disabled == nil { + var ret bool + return ret + } + return *o.Disabled +} + +// GetDisabledOk returns a tuple with the Disabled field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountPayoutState) GetDisabledOk() (*bool, bool) { + if o == nil || o.Disabled == nil { + return nil, false + } + return o.Disabled, true +} + +// HasDisabled returns a boolean if a field has been set. +func (o *AccountPayoutState) HasDisabled() bool { + if o != nil && o.Disabled != nil { + return true + } + + return false +} + +// SetDisabled gets a reference to the given bool and assigns it to the Disabled field. +func (o *AccountPayoutState) SetDisabled(v bool) { + o.Disabled = &v +} + +// GetNotAllowedReason returns the NotAllowedReason field value if set, zero value otherwise. +func (o *AccountPayoutState) GetNotAllowedReason() string { + if o == nil || o.NotAllowedReason == nil { + var ret string + return ret + } + return *o.NotAllowedReason +} + +// GetNotAllowedReasonOk returns a tuple with the NotAllowedReason field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountPayoutState) GetNotAllowedReasonOk() (*string, bool) { + if o == nil || o.NotAllowedReason == nil { + return nil, false + } + return o.NotAllowedReason, true +} + +// HasNotAllowedReason returns a boolean if a field has been set. +func (o *AccountPayoutState) HasNotAllowedReason() bool { + if o != nil && o.NotAllowedReason != nil { + return true + } + + return false +} + +// SetNotAllowedReason gets a reference to the given string and assigns it to the NotAllowedReason field. +func (o *AccountPayoutState) SetNotAllowedReason(v string) { + o.NotAllowedReason = &v +} + +// GetPayoutLimit returns the PayoutLimit field value if set, zero value otherwise. +func (o *AccountPayoutState) GetPayoutLimit() Amount { + if o == nil || o.PayoutLimit == nil { + var ret Amount + return ret + } + return *o.PayoutLimit +} + +// GetPayoutLimitOk returns a tuple with the PayoutLimit field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountPayoutState) GetPayoutLimitOk() (*Amount, bool) { + if o == nil || o.PayoutLimit == nil { + return nil, false + } + return o.PayoutLimit, true +} + +// HasPayoutLimit returns a boolean if a field has been set. +func (o *AccountPayoutState) HasPayoutLimit() bool { + if o != nil && o.PayoutLimit != nil { + return true + } + + return false +} + +// SetPayoutLimit gets a reference to the given Amount and assigns it to the PayoutLimit field. +func (o *AccountPayoutState) SetPayoutLimit(v Amount) { + o.PayoutLimit = &v +} + +// GetTierNumber returns the TierNumber field value if set, zero value otherwise. +func (o *AccountPayoutState) GetTierNumber() int32 { + if o == nil || o.TierNumber == nil { + var ret int32 + return ret + } + return *o.TierNumber +} + +// GetTierNumberOk returns a tuple with the TierNumber field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountPayoutState) GetTierNumberOk() (*int32, bool) { + if o == nil || o.TierNumber == nil { + return nil, false + } + return o.TierNumber, true +} + +// HasTierNumber returns a boolean if a field has been set. +func (o *AccountPayoutState) HasTierNumber() bool { + if o != nil && o.TierNumber != nil { + return true + } + + return false +} + +// SetTierNumber gets a reference to the given int32 and assigns it to the TierNumber field. +func (o *AccountPayoutState) SetTierNumber(v int32) { + o.TierNumber = &v +} + +func (o AccountPayoutState) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.AllowPayout != nil { + toSerialize["allowPayout"] = o.AllowPayout + } + if o.DisableReason != nil { + toSerialize["disableReason"] = o.DisableReason + } + if o.Disabled != nil { + toSerialize["disabled"] = o.Disabled + } + if o.NotAllowedReason != nil { + toSerialize["notAllowedReason"] = o.NotAllowedReason + } + if o.PayoutLimit != nil { + toSerialize["payoutLimit"] = o.PayoutLimit + } + if o.TierNumber != nil { + toSerialize["tierNumber"] = o.TierNumber + } + return json.Marshal(toSerialize) +} + +type NullableAccountPayoutState struct { + value *AccountPayoutState + isSet bool +} + +func (v NullableAccountPayoutState) Get() *AccountPayoutState { + return v.value +} + +func (v *NullableAccountPayoutState) Set(val *AccountPayoutState) { + v.value = val + v.isSet = true +} + +func (v NullableAccountPayoutState) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountPayoutState) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountPayoutState(val *AccountPayoutState) *NullableAccountPayoutState { + return &NullableAccountPayoutState{value: val, isSet: true} +} + +func (v NullableAccountPayoutState) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountPayoutState) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_processing_state.go b/src/platformsnotificationevents/model_account_processing_state.go new file mode 100644 index 000000000..d90d2432e --- /dev/null +++ b/src/platformsnotificationevents/model_account_processing_state.go @@ -0,0 +1,263 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// AccountProcessingState struct for AccountProcessingState +type AccountProcessingState struct { + // The reason why processing has been disabled. + DisableReason *string `json:"disableReason,omitempty"` + // Indicates whether the processing of payments is allowed. + Disabled *bool `json:"disabled,omitempty"` + ProcessedFrom *Amount `json:"processedFrom,omitempty"` + ProcessedTo *Amount `json:"processedTo,omitempty"` + // The processing tier that the account holder occupies. + TierNumber *int32 `json:"tierNumber,omitempty"` +} + +// NewAccountProcessingState instantiates a new AccountProcessingState object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountProcessingState() *AccountProcessingState { + this := AccountProcessingState{} + return &this +} + +// NewAccountProcessingStateWithDefaults instantiates a new AccountProcessingState object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountProcessingStateWithDefaults() *AccountProcessingState { + this := AccountProcessingState{} + return &this +} + +// GetDisableReason returns the DisableReason field value if set, zero value otherwise. +func (o *AccountProcessingState) GetDisableReason() string { + if o == nil || o.DisableReason == nil { + var ret string + return ret + } + return *o.DisableReason +} + +// GetDisableReasonOk returns a tuple with the DisableReason field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountProcessingState) GetDisableReasonOk() (*string, bool) { + if o == nil || o.DisableReason == nil { + return nil, false + } + return o.DisableReason, true +} + +// HasDisableReason returns a boolean if a field has been set. +func (o *AccountProcessingState) HasDisableReason() bool { + if o != nil && o.DisableReason != nil { + return true + } + + return false +} + +// SetDisableReason gets a reference to the given string and assigns it to the DisableReason field. +func (o *AccountProcessingState) SetDisableReason(v string) { + o.DisableReason = &v +} + +// GetDisabled returns the Disabled field value if set, zero value otherwise. +func (o *AccountProcessingState) GetDisabled() bool { + if o == nil || o.Disabled == nil { + var ret bool + return ret + } + return *o.Disabled +} + +// GetDisabledOk returns a tuple with the Disabled field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountProcessingState) GetDisabledOk() (*bool, bool) { + if o == nil || o.Disabled == nil { + return nil, false + } + return o.Disabled, true +} + +// HasDisabled returns a boolean if a field has been set. +func (o *AccountProcessingState) HasDisabled() bool { + if o != nil && o.Disabled != nil { + return true + } + + return false +} + +// SetDisabled gets a reference to the given bool and assigns it to the Disabled field. +func (o *AccountProcessingState) SetDisabled(v bool) { + o.Disabled = &v +} + +// GetProcessedFrom returns the ProcessedFrom field value if set, zero value otherwise. +func (o *AccountProcessingState) GetProcessedFrom() Amount { + if o == nil || o.ProcessedFrom == nil { + var ret Amount + return ret + } + return *o.ProcessedFrom +} + +// GetProcessedFromOk returns a tuple with the ProcessedFrom field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountProcessingState) GetProcessedFromOk() (*Amount, bool) { + if o == nil || o.ProcessedFrom == nil { + return nil, false + } + return o.ProcessedFrom, true +} + +// HasProcessedFrom returns a boolean if a field has been set. +func (o *AccountProcessingState) HasProcessedFrom() bool { + if o != nil && o.ProcessedFrom != nil { + return true + } + + return false +} + +// SetProcessedFrom gets a reference to the given Amount and assigns it to the ProcessedFrom field. +func (o *AccountProcessingState) SetProcessedFrom(v Amount) { + o.ProcessedFrom = &v +} + +// GetProcessedTo returns the ProcessedTo field value if set, zero value otherwise. +func (o *AccountProcessingState) GetProcessedTo() Amount { + if o == nil || o.ProcessedTo == nil { + var ret Amount + return ret + } + return *o.ProcessedTo +} + +// GetProcessedToOk returns a tuple with the ProcessedTo field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountProcessingState) GetProcessedToOk() (*Amount, bool) { + if o == nil || o.ProcessedTo == nil { + return nil, false + } + return o.ProcessedTo, true +} + +// HasProcessedTo returns a boolean if a field has been set. +func (o *AccountProcessingState) HasProcessedTo() bool { + if o != nil && o.ProcessedTo != nil { + return true + } + + return false +} + +// SetProcessedTo gets a reference to the given Amount and assigns it to the ProcessedTo field. +func (o *AccountProcessingState) SetProcessedTo(v Amount) { + o.ProcessedTo = &v +} + +// GetTierNumber returns the TierNumber field value if set, zero value otherwise. +func (o *AccountProcessingState) GetTierNumber() int32 { + if o == nil || o.TierNumber == nil { + var ret int32 + return ret + } + return *o.TierNumber +} + +// GetTierNumberOk returns a tuple with the TierNumber field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountProcessingState) GetTierNumberOk() (*int32, bool) { + if o == nil || o.TierNumber == nil { + return nil, false + } + return o.TierNumber, true +} + +// HasTierNumber returns a boolean if a field has been set. +func (o *AccountProcessingState) HasTierNumber() bool { + if o != nil && o.TierNumber != nil { + return true + } + + return false +} + +// SetTierNumber gets a reference to the given int32 and assigns it to the TierNumber field. +func (o *AccountProcessingState) SetTierNumber(v int32) { + o.TierNumber = &v +} + +func (o AccountProcessingState) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DisableReason != nil { + toSerialize["disableReason"] = o.DisableReason + } + if o.Disabled != nil { + toSerialize["disabled"] = o.Disabled + } + if o.ProcessedFrom != nil { + toSerialize["processedFrom"] = o.ProcessedFrom + } + if o.ProcessedTo != nil { + toSerialize["processedTo"] = o.ProcessedTo + } + if o.TierNumber != nil { + toSerialize["tierNumber"] = o.TierNumber + } + return json.Marshal(toSerialize) +} + +type NullableAccountProcessingState struct { + value *AccountProcessingState + isSet bool +} + +func (v NullableAccountProcessingState) Get() *AccountProcessingState { + return v.value +} + +func (v *NullableAccountProcessingState) Set(val *AccountProcessingState) { + v.value = val + v.isSet = true +} + +func (v NullableAccountProcessingState) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountProcessingState) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountProcessingState(val *AccountProcessingState) *NullableAccountProcessingState { + return &NullableAccountProcessingState{value: val, isSet: true} +} + +func (v NullableAccountProcessingState) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountProcessingState) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_account_update_notification.go b/src/platformsnotificationevents/model_account_update_notification.go new file mode 100644 index 000000000..e879e65c8 --- /dev/null +++ b/src/platformsnotificationevents/model_account_update_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// AccountUpdateNotification struct for AccountUpdateNotification +type AccountUpdateNotification struct { + Content UpdateAccountResponse `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewAccountUpdateNotification instantiates a new AccountUpdateNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAccountUpdateNotification(content UpdateAccountResponse, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *AccountUpdateNotification { + this := AccountUpdateNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewAccountUpdateNotificationWithDefaults instantiates a new AccountUpdateNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAccountUpdateNotificationWithDefaults() *AccountUpdateNotification { + this := AccountUpdateNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *AccountUpdateNotification) GetContent() UpdateAccountResponse { + if o == nil { + var ret UpdateAccountResponse + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *AccountUpdateNotification) GetContentOk() (*UpdateAccountResponse, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *AccountUpdateNotification) SetContent(v UpdateAccountResponse) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *AccountUpdateNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AccountUpdateNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *AccountUpdateNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *AccountUpdateNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *AccountUpdateNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *AccountUpdateNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *AccountUpdateNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *AccountUpdateNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *AccountUpdateNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *AccountUpdateNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *AccountUpdateNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *AccountUpdateNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *AccountUpdateNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *AccountUpdateNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *AccountUpdateNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *AccountUpdateNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *AccountUpdateNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *AccountUpdateNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *AccountUpdateNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o AccountUpdateNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableAccountUpdateNotification struct { + value *AccountUpdateNotification + isSet bool +} + +func (v NullableAccountUpdateNotification) Get() *AccountUpdateNotification { + return v.value +} + +func (v *NullableAccountUpdateNotification) Set(val *AccountUpdateNotification) { + v.value = val + v.isSet = true +} + +func (v NullableAccountUpdateNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableAccountUpdateNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAccountUpdateNotification(val *AccountUpdateNotification) *NullableAccountUpdateNotification { + return &NullableAccountUpdateNotification{value: val, isSet: true} +} + +func (v NullableAccountUpdateNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAccountUpdateNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_amount.go b/src/platformsnotificationevents/model_amount.go new file mode 100644 index 000000000..b2d2c2ad7 --- /dev/null +++ b/src/platformsnotificationevents/model_amount.go @@ -0,0 +1,140 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// Amount struct for Amount +type Amount struct { + // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + Currency string `json:"currency"` + // The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + Value int64 `json:"value"` +} + +// NewAmount instantiates a new Amount object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewAmount(currency string, value int64, ) *Amount { + this := Amount{} + this.Currency = currency + this.Value = value + return &this +} + +// NewAmountWithDefaults instantiates a new Amount object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewAmountWithDefaults() *Amount { + this := Amount{} + return &this +} + +// GetCurrency returns the Currency field value +func (o *Amount) GetCurrency() string { + if o == nil { + var ret string + return ret + } + + return o.Currency +} + +// GetCurrencyOk returns a tuple with the Currency field value +// and a boolean to check if the value has been set. +func (o *Amount) GetCurrencyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Currency, true +} + +// SetCurrency sets field value +func (o *Amount) SetCurrency(v string) { + o.Currency = v +} + +// GetValue returns the Value field value +func (o *Amount) GetValue() int64 { + if o == nil { + var ret int64 + return ret + } + + return o.Value +} + +// GetValueOk returns a tuple with the Value field value +// and a boolean to check if the value has been set. +func (o *Amount) GetValueOk() (*int64, bool) { + if o == nil { + return nil, false + } + return &o.Value, true +} + +// SetValue sets field value +func (o *Amount) SetValue(v int64) { + o.Value = v +} + +func (o Amount) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["currency"] = o.Currency + } + if true { + toSerialize["value"] = o.Value + } + return json.Marshal(toSerialize) +} + +type NullableAmount struct { + value *Amount + isSet bool +} + +func (v NullableAmount) Get() *Amount { + return v.value +} + +func (v *NullableAmount) Set(val *Amount) { + v.value = val + v.isSet = true +} + +func (v NullableAmount) IsSet() bool { + return v.isSet +} + +func (v *NullableAmount) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableAmount(val *Amount) *NullableAmount { + return &NullableAmount{value: val, isSet: true} +} + +func (v NullableAmount) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableAmount) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_bank_account_detail.go b/src/platformsnotificationevents/model_bank_account_detail.go new file mode 100644 index 000000000..15367ec75 --- /dev/null +++ b/src/platformsnotificationevents/model_bank_account_detail.go @@ -0,0 +1,1042 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// BankAccountDetail struct for BankAccountDetail +type BankAccountDetail struct { + // The bank account number (without separators). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + AccountNumber *string `json:"accountNumber,omitempty"` + // The type of bank account. Only applicable to bank accounts held in the USA. The permitted values are: `checking`, `savings`. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + AccountType *string `json:"accountType,omitempty"` + // The name of the bank account. + BankAccountName *string `json:"bankAccountName,omitempty"` + // Merchant reference to the bank account. + BankAccountReference *string `json:"bankAccountReference,omitempty"` + // The unique identifier (UUID) of the Bank Account. >If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID. >If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue. >If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail. >If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated. + BankAccountUUID *string `json:"bankAccountUUID,omitempty"` + // The bank identifier code. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + BankBicSwift *string `json:"bankBicSwift,omitempty"` + // The city in which the bank branch is located. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + BankCity *string `json:"bankCity,omitempty"` + // The bank code of the banking institution with which the bank account is registered. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + BankCode *string `json:"bankCode,omitempty"` + // The name of the banking institution with which the bank account is held. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + BankName *string `json:"bankName,omitempty"` + // The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account: * United States - Routing number * United Kingdom - Sort code * Germany - Bankleitzahl >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + BranchCode *string `json:"branchCode,omitempty"` + // The check code of the bank account. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + CheckCode *string `json:"checkCode,omitempty"` + // The two-letter country code in which the bank account is registered. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + CountryCode *string `json:"countryCode,omitempty"` + // The currency in which the bank account deals. >The permitted currency codes are defined in ISO-4217 (e.g. 'EUR'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + CurrencyCode *string `json:"currencyCode,omitempty"` + // The international bank account number. >The IBAN standard is defined in ISO-13616. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + Iban *string `json:"iban,omitempty"` + // The city of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + OwnerCity *string `json:"ownerCity,omitempty"` + // The country code of the country of residence of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + OwnerCountryCode *string `json:"ownerCountryCode,omitempty"` + // The date of birth of the bank account owner. + OwnerDateOfBirth *string `json:"ownerDateOfBirth,omitempty"` + // The house name or number of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + OwnerHouseNumberOrName *string `json:"ownerHouseNumberOrName,omitempty"` + // The name of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + OwnerName *string `json:"ownerName,omitempty"` + // The country code of the country of nationality of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + OwnerNationality *string `json:"ownerNationality,omitempty"` + // The postal code of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + OwnerPostalCode *string `json:"ownerPostalCode,omitempty"` + // The state of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + OwnerState *string `json:"ownerState,omitempty"` + // The street name of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + OwnerStreet *string `json:"ownerStreet,omitempty"` + // If set to true, the bank account is a primary account. + PrimaryAccount *bool `json:"primaryAccount,omitempty"` + // The tax ID number. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + TaxId *string `json:"taxId,omitempty"` + // The URL to be used for bank account verification. This may be generated on bank account creation. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + UrlForVerification *string `json:"urlForVerification,omitempty"` +} + +// NewBankAccountDetail instantiates a new BankAccountDetail object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewBankAccountDetail() *BankAccountDetail { + this := BankAccountDetail{} + return &this +} + +// NewBankAccountDetailWithDefaults instantiates a new BankAccountDetail object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewBankAccountDetailWithDefaults() *BankAccountDetail { + this := BankAccountDetail{} + return &this +} + +// GetAccountNumber returns the AccountNumber field value if set, zero value otherwise. +func (o *BankAccountDetail) GetAccountNumber() string { + if o == nil || o.AccountNumber == nil { + var ret string + return ret + } + return *o.AccountNumber +} + +// GetAccountNumberOk returns a tuple with the AccountNumber field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetAccountNumberOk() (*string, bool) { + if o == nil || o.AccountNumber == nil { + return nil, false + } + return o.AccountNumber, true +} + +// HasAccountNumber returns a boolean if a field has been set. +func (o *BankAccountDetail) HasAccountNumber() bool { + if o != nil && o.AccountNumber != nil { + return true + } + + return false +} + +// SetAccountNumber gets a reference to the given string and assigns it to the AccountNumber field. +func (o *BankAccountDetail) SetAccountNumber(v string) { + o.AccountNumber = &v +} + +// GetAccountType returns the AccountType field value if set, zero value otherwise. +func (o *BankAccountDetail) GetAccountType() string { + if o == nil || o.AccountType == nil { + var ret string + return ret + } + return *o.AccountType +} + +// GetAccountTypeOk returns a tuple with the AccountType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetAccountTypeOk() (*string, bool) { + if o == nil || o.AccountType == nil { + return nil, false + } + return o.AccountType, true +} + +// HasAccountType returns a boolean if a field has been set. +func (o *BankAccountDetail) HasAccountType() bool { + if o != nil && o.AccountType != nil { + return true + } + + return false +} + +// SetAccountType gets a reference to the given string and assigns it to the AccountType field. +func (o *BankAccountDetail) SetAccountType(v string) { + o.AccountType = &v +} + +// GetBankAccountName returns the BankAccountName field value if set, zero value otherwise. +func (o *BankAccountDetail) GetBankAccountName() string { + if o == nil || o.BankAccountName == nil { + var ret string + return ret + } + return *o.BankAccountName +} + +// GetBankAccountNameOk returns a tuple with the BankAccountName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetBankAccountNameOk() (*string, bool) { + if o == nil || o.BankAccountName == nil { + return nil, false + } + return o.BankAccountName, true +} + +// HasBankAccountName returns a boolean if a field has been set. +func (o *BankAccountDetail) HasBankAccountName() bool { + if o != nil && o.BankAccountName != nil { + return true + } + + return false +} + +// SetBankAccountName gets a reference to the given string and assigns it to the BankAccountName field. +func (o *BankAccountDetail) SetBankAccountName(v string) { + o.BankAccountName = &v +} + +// GetBankAccountReference returns the BankAccountReference field value if set, zero value otherwise. +func (o *BankAccountDetail) GetBankAccountReference() string { + if o == nil || o.BankAccountReference == nil { + var ret string + return ret + } + return *o.BankAccountReference +} + +// GetBankAccountReferenceOk returns a tuple with the BankAccountReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetBankAccountReferenceOk() (*string, bool) { + if o == nil || o.BankAccountReference == nil { + return nil, false + } + return o.BankAccountReference, true +} + +// HasBankAccountReference returns a boolean if a field has been set. +func (o *BankAccountDetail) HasBankAccountReference() bool { + if o != nil && o.BankAccountReference != nil { + return true + } + + return false +} + +// SetBankAccountReference gets a reference to the given string and assigns it to the BankAccountReference field. +func (o *BankAccountDetail) SetBankAccountReference(v string) { + o.BankAccountReference = &v +} + +// GetBankAccountUUID returns the BankAccountUUID field value if set, zero value otherwise. +func (o *BankAccountDetail) GetBankAccountUUID() string { + if o == nil || o.BankAccountUUID == nil { + var ret string + return ret + } + return *o.BankAccountUUID +} + +// GetBankAccountUUIDOk returns a tuple with the BankAccountUUID field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetBankAccountUUIDOk() (*string, bool) { + if o == nil || o.BankAccountUUID == nil { + return nil, false + } + return o.BankAccountUUID, true +} + +// HasBankAccountUUID returns a boolean if a field has been set. +func (o *BankAccountDetail) HasBankAccountUUID() bool { + if o != nil && o.BankAccountUUID != nil { + return true + } + + return false +} + +// SetBankAccountUUID gets a reference to the given string and assigns it to the BankAccountUUID field. +func (o *BankAccountDetail) SetBankAccountUUID(v string) { + o.BankAccountUUID = &v +} + +// GetBankBicSwift returns the BankBicSwift field value if set, zero value otherwise. +func (o *BankAccountDetail) GetBankBicSwift() string { + if o == nil || o.BankBicSwift == nil { + var ret string + return ret + } + return *o.BankBicSwift +} + +// GetBankBicSwiftOk returns a tuple with the BankBicSwift field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetBankBicSwiftOk() (*string, bool) { + if o == nil || o.BankBicSwift == nil { + return nil, false + } + return o.BankBicSwift, true +} + +// HasBankBicSwift returns a boolean if a field has been set. +func (o *BankAccountDetail) HasBankBicSwift() bool { + if o != nil && o.BankBicSwift != nil { + return true + } + + return false +} + +// SetBankBicSwift gets a reference to the given string and assigns it to the BankBicSwift field. +func (o *BankAccountDetail) SetBankBicSwift(v string) { + o.BankBicSwift = &v +} + +// GetBankCity returns the BankCity field value if set, zero value otherwise. +func (o *BankAccountDetail) GetBankCity() string { + if o == nil || o.BankCity == nil { + var ret string + return ret + } + return *o.BankCity +} + +// GetBankCityOk returns a tuple with the BankCity field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetBankCityOk() (*string, bool) { + if o == nil || o.BankCity == nil { + return nil, false + } + return o.BankCity, true +} + +// HasBankCity returns a boolean if a field has been set. +func (o *BankAccountDetail) HasBankCity() bool { + if o != nil && o.BankCity != nil { + return true + } + + return false +} + +// SetBankCity gets a reference to the given string and assigns it to the BankCity field. +func (o *BankAccountDetail) SetBankCity(v string) { + o.BankCity = &v +} + +// GetBankCode returns the BankCode field value if set, zero value otherwise. +func (o *BankAccountDetail) GetBankCode() string { + if o == nil || o.BankCode == nil { + var ret string + return ret + } + return *o.BankCode +} + +// GetBankCodeOk returns a tuple with the BankCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetBankCodeOk() (*string, bool) { + if o == nil || o.BankCode == nil { + return nil, false + } + return o.BankCode, true +} + +// HasBankCode returns a boolean if a field has been set. +func (o *BankAccountDetail) HasBankCode() bool { + if o != nil && o.BankCode != nil { + return true + } + + return false +} + +// SetBankCode gets a reference to the given string and assigns it to the BankCode field. +func (o *BankAccountDetail) SetBankCode(v string) { + o.BankCode = &v +} + +// GetBankName returns the BankName field value if set, zero value otherwise. +func (o *BankAccountDetail) GetBankName() string { + if o == nil || o.BankName == nil { + var ret string + return ret + } + return *o.BankName +} + +// GetBankNameOk returns a tuple with the BankName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetBankNameOk() (*string, bool) { + if o == nil || o.BankName == nil { + return nil, false + } + return o.BankName, true +} + +// HasBankName returns a boolean if a field has been set. +func (o *BankAccountDetail) HasBankName() bool { + if o != nil && o.BankName != nil { + return true + } + + return false +} + +// SetBankName gets a reference to the given string and assigns it to the BankName field. +func (o *BankAccountDetail) SetBankName(v string) { + o.BankName = &v +} + +// GetBranchCode returns the BranchCode field value if set, zero value otherwise. +func (o *BankAccountDetail) GetBranchCode() string { + if o == nil || o.BranchCode == nil { + var ret string + return ret + } + return *o.BranchCode +} + +// GetBranchCodeOk returns a tuple with the BranchCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetBranchCodeOk() (*string, bool) { + if o == nil || o.BranchCode == nil { + return nil, false + } + return o.BranchCode, true +} + +// HasBranchCode returns a boolean if a field has been set. +func (o *BankAccountDetail) HasBranchCode() bool { + if o != nil && o.BranchCode != nil { + return true + } + + return false +} + +// SetBranchCode gets a reference to the given string and assigns it to the BranchCode field. +func (o *BankAccountDetail) SetBranchCode(v string) { + o.BranchCode = &v +} + +// GetCheckCode returns the CheckCode field value if set, zero value otherwise. +func (o *BankAccountDetail) GetCheckCode() string { + if o == nil || o.CheckCode == nil { + var ret string + return ret + } + return *o.CheckCode +} + +// GetCheckCodeOk returns a tuple with the CheckCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetCheckCodeOk() (*string, bool) { + if o == nil || o.CheckCode == nil { + return nil, false + } + return o.CheckCode, true +} + +// HasCheckCode returns a boolean if a field has been set. +func (o *BankAccountDetail) HasCheckCode() bool { + if o != nil && o.CheckCode != nil { + return true + } + + return false +} + +// SetCheckCode gets a reference to the given string and assigns it to the CheckCode field. +func (o *BankAccountDetail) SetCheckCode(v string) { + o.CheckCode = &v +} + +// GetCountryCode returns the CountryCode field value if set, zero value otherwise. +func (o *BankAccountDetail) GetCountryCode() string { + if o == nil || o.CountryCode == nil { + var ret string + return ret + } + return *o.CountryCode +} + +// GetCountryCodeOk returns a tuple with the CountryCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetCountryCodeOk() (*string, bool) { + if o == nil || o.CountryCode == nil { + return nil, false + } + return o.CountryCode, true +} + +// HasCountryCode returns a boolean if a field has been set. +func (o *BankAccountDetail) HasCountryCode() bool { + if o != nil && o.CountryCode != nil { + return true + } + + return false +} + +// SetCountryCode gets a reference to the given string and assigns it to the CountryCode field. +func (o *BankAccountDetail) SetCountryCode(v string) { + o.CountryCode = &v +} + +// GetCurrencyCode returns the CurrencyCode field value if set, zero value otherwise. +func (o *BankAccountDetail) GetCurrencyCode() string { + if o == nil || o.CurrencyCode == nil { + var ret string + return ret + } + return *o.CurrencyCode +} + +// GetCurrencyCodeOk returns a tuple with the CurrencyCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetCurrencyCodeOk() (*string, bool) { + if o == nil || o.CurrencyCode == nil { + return nil, false + } + return o.CurrencyCode, true +} + +// HasCurrencyCode returns a boolean if a field has been set. +func (o *BankAccountDetail) HasCurrencyCode() bool { + if o != nil && o.CurrencyCode != nil { + return true + } + + return false +} + +// SetCurrencyCode gets a reference to the given string and assigns it to the CurrencyCode field. +func (o *BankAccountDetail) SetCurrencyCode(v string) { + o.CurrencyCode = &v +} + +// GetIban returns the Iban field value if set, zero value otherwise. +func (o *BankAccountDetail) GetIban() string { + if o == nil || o.Iban == nil { + var ret string + return ret + } + return *o.Iban +} + +// GetIbanOk returns a tuple with the Iban field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetIbanOk() (*string, bool) { + if o == nil || o.Iban == nil { + return nil, false + } + return o.Iban, true +} + +// HasIban returns a boolean if a field has been set. +func (o *BankAccountDetail) HasIban() bool { + if o != nil && o.Iban != nil { + return true + } + + return false +} + +// SetIban gets a reference to the given string and assigns it to the Iban field. +func (o *BankAccountDetail) SetIban(v string) { + o.Iban = &v +} + +// GetOwnerCity returns the OwnerCity field value if set, zero value otherwise. +func (o *BankAccountDetail) GetOwnerCity() string { + if o == nil || o.OwnerCity == nil { + var ret string + return ret + } + return *o.OwnerCity +} + +// GetOwnerCityOk returns a tuple with the OwnerCity field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetOwnerCityOk() (*string, bool) { + if o == nil || o.OwnerCity == nil { + return nil, false + } + return o.OwnerCity, true +} + +// HasOwnerCity returns a boolean if a field has been set. +func (o *BankAccountDetail) HasOwnerCity() bool { + if o != nil && o.OwnerCity != nil { + return true + } + + return false +} + +// SetOwnerCity gets a reference to the given string and assigns it to the OwnerCity field. +func (o *BankAccountDetail) SetOwnerCity(v string) { + o.OwnerCity = &v +} + +// GetOwnerCountryCode returns the OwnerCountryCode field value if set, zero value otherwise. +func (o *BankAccountDetail) GetOwnerCountryCode() string { + if o == nil || o.OwnerCountryCode == nil { + var ret string + return ret + } + return *o.OwnerCountryCode +} + +// GetOwnerCountryCodeOk returns a tuple with the OwnerCountryCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetOwnerCountryCodeOk() (*string, bool) { + if o == nil || o.OwnerCountryCode == nil { + return nil, false + } + return o.OwnerCountryCode, true +} + +// HasOwnerCountryCode returns a boolean if a field has been set. +func (o *BankAccountDetail) HasOwnerCountryCode() bool { + if o != nil && o.OwnerCountryCode != nil { + return true + } + + return false +} + +// SetOwnerCountryCode gets a reference to the given string and assigns it to the OwnerCountryCode field. +func (o *BankAccountDetail) SetOwnerCountryCode(v string) { + o.OwnerCountryCode = &v +} + +// GetOwnerDateOfBirth returns the OwnerDateOfBirth field value if set, zero value otherwise. +func (o *BankAccountDetail) GetOwnerDateOfBirth() string { + if o == nil || o.OwnerDateOfBirth == nil { + var ret string + return ret + } + return *o.OwnerDateOfBirth +} + +// GetOwnerDateOfBirthOk returns a tuple with the OwnerDateOfBirth field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetOwnerDateOfBirthOk() (*string, bool) { + if o == nil || o.OwnerDateOfBirth == nil { + return nil, false + } + return o.OwnerDateOfBirth, true +} + +// HasOwnerDateOfBirth returns a boolean if a field has been set. +func (o *BankAccountDetail) HasOwnerDateOfBirth() bool { + if o != nil && o.OwnerDateOfBirth != nil { + return true + } + + return false +} + +// SetOwnerDateOfBirth gets a reference to the given string and assigns it to the OwnerDateOfBirth field. +func (o *BankAccountDetail) SetOwnerDateOfBirth(v string) { + o.OwnerDateOfBirth = &v +} + +// GetOwnerHouseNumberOrName returns the OwnerHouseNumberOrName field value if set, zero value otherwise. +func (o *BankAccountDetail) GetOwnerHouseNumberOrName() string { + if o == nil || o.OwnerHouseNumberOrName == nil { + var ret string + return ret + } + return *o.OwnerHouseNumberOrName +} + +// GetOwnerHouseNumberOrNameOk returns a tuple with the OwnerHouseNumberOrName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetOwnerHouseNumberOrNameOk() (*string, bool) { + if o == nil || o.OwnerHouseNumberOrName == nil { + return nil, false + } + return o.OwnerHouseNumberOrName, true +} + +// HasOwnerHouseNumberOrName returns a boolean if a field has been set. +func (o *BankAccountDetail) HasOwnerHouseNumberOrName() bool { + if o != nil && o.OwnerHouseNumberOrName != nil { + return true + } + + return false +} + +// SetOwnerHouseNumberOrName gets a reference to the given string and assigns it to the OwnerHouseNumberOrName field. +func (o *BankAccountDetail) SetOwnerHouseNumberOrName(v string) { + o.OwnerHouseNumberOrName = &v +} + +// GetOwnerName returns the OwnerName field value if set, zero value otherwise. +func (o *BankAccountDetail) GetOwnerName() string { + if o == nil || o.OwnerName == nil { + var ret string + return ret + } + return *o.OwnerName +} + +// GetOwnerNameOk returns a tuple with the OwnerName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetOwnerNameOk() (*string, bool) { + if o == nil || o.OwnerName == nil { + return nil, false + } + return o.OwnerName, true +} + +// HasOwnerName returns a boolean if a field has been set. +func (o *BankAccountDetail) HasOwnerName() bool { + if o != nil && o.OwnerName != nil { + return true + } + + return false +} + +// SetOwnerName gets a reference to the given string and assigns it to the OwnerName field. +func (o *BankAccountDetail) SetOwnerName(v string) { + o.OwnerName = &v +} + +// GetOwnerNationality returns the OwnerNationality field value if set, zero value otherwise. +func (o *BankAccountDetail) GetOwnerNationality() string { + if o == nil || o.OwnerNationality == nil { + var ret string + return ret + } + return *o.OwnerNationality +} + +// GetOwnerNationalityOk returns a tuple with the OwnerNationality field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetOwnerNationalityOk() (*string, bool) { + if o == nil || o.OwnerNationality == nil { + return nil, false + } + return o.OwnerNationality, true +} + +// HasOwnerNationality returns a boolean if a field has been set. +func (o *BankAccountDetail) HasOwnerNationality() bool { + if o != nil && o.OwnerNationality != nil { + return true + } + + return false +} + +// SetOwnerNationality gets a reference to the given string and assigns it to the OwnerNationality field. +func (o *BankAccountDetail) SetOwnerNationality(v string) { + o.OwnerNationality = &v +} + +// GetOwnerPostalCode returns the OwnerPostalCode field value if set, zero value otherwise. +func (o *BankAccountDetail) GetOwnerPostalCode() string { + if o == nil || o.OwnerPostalCode == nil { + var ret string + return ret + } + return *o.OwnerPostalCode +} + +// GetOwnerPostalCodeOk returns a tuple with the OwnerPostalCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetOwnerPostalCodeOk() (*string, bool) { + if o == nil || o.OwnerPostalCode == nil { + return nil, false + } + return o.OwnerPostalCode, true +} + +// HasOwnerPostalCode returns a boolean if a field has been set. +func (o *BankAccountDetail) HasOwnerPostalCode() bool { + if o != nil && o.OwnerPostalCode != nil { + return true + } + + return false +} + +// SetOwnerPostalCode gets a reference to the given string and assigns it to the OwnerPostalCode field. +func (o *BankAccountDetail) SetOwnerPostalCode(v string) { + o.OwnerPostalCode = &v +} + +// GetOwnerState returns the OwnerState field value if set, zero value otherwise. +func (o *BankAccountDetail) GetOwnerState() string { + if o == nil || o.OwnerState == nil { + var ret string + return ret + } + return *o.OwnerState +} + +// GetOwnerStateOk returns a tuple with the OwnerState field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetOwnerStateOk() (*string, bool) { + if o == nil || o.OwnerState == nil { + return nil, false + } + return o.OwnerState, true +} + +// HasOwnerState returns a boolean if a field has been set. +func (o *BankAccountDetail) HasOwnerState() bool { + if o != nil && o.OwnerState != nil { + return true + } + + return false +} + +// SetOwnerState gets a reference to the given string and assigns it to the OwnerState field. +func (o *BankAccountDetail) SetOwnerState(v string) { + o.OwnerState = &v +} + +// GetOwnerStreet returns the OwnerStreet field value if set, zero value otherwise. +func (o *BankAccountDetail) GetOwnerStreet() string { + if o == nil || o.OwnerStreet == nil { + var ret string + return ret + } + return *o.OwnerStreet +} + +// GetOwnerStreetOk returns a tuple with the OwnerStreet field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetOwnerStreetOk() (*string, bool) { + if o == nil || o.OwnerStreet == nil { + return nil, false + } + return o.OwnerStreet, true +} + +// HasOwnerStreet returns a boolean if a field has been set. +func (o *BankAccountDetail) HasOwnerStreet() bool { + if o != nil && o.OwnerStreet != nil { + return true + } + + return false +} + +// SetOwnerStreet gets a reference to the given string and assigns it to the OwnerStreet field. +func (o *BankAccountDetail) SetOwnerStreet(v string) { + o.OwnerStreet = &v +} + +// GetPrimaryAccount returns the PrimaryAccount field value if set, zero value otherwise. +func (o *BankAccountDetail) GetPrimaryAccount() bool { + if o == nil || o.PrimaryAccount == nil { + var ret bool + return ret + } + return *o.PrimaryAccount +} + +// GetPrimaryAccountOk returns a tuple with the PrimaryAccount field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetPrimaryAccountOk() (*bool, bool) { + if o == nil || o.PrimaryAccount == nil { + return nil, false + } + return o.PrimaryAccount, true +} + +// HasPrimaryAccount returns a boolean if a field has been set. +func (o *BankAccountDetail) HasPrimaryAccount() bool { + if o != nil && o.PrimaryAccount != nil { + return true + } + + return false +} + +// SetPrimaryAccount gets a reference to the given bool and assigns it to the PrimaryAccount field. +func (o *BankAccountDetail) SetPrimaryAccount(v bool) { + o.PrimaryAccount = &v +} + +// GetTaxId returns the TaxId field value if set, zero value otherwise. +func (o *BankAccountDetail) GetTaxId() string { + if o == nil || o.TaxId == nil { + var ret string + return ret + } + return *o.TaxId +} + +// GetTaxIdOk returns a tuple with the TaxId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetTaxIdOk() (*string, bool) { + if o == nil || o.TaxId == nil { + return nil, false + } + return o.TaxId, true +} + +// HasTaxId returns a boolean if a field has been set. +func (o *BankAccountDetail) HasTaxId() bool { + if o != nil && o.TaxId != nil { + return true + } + + return false +} + +// SetTaxId gets a reference to the given string and assigns it to the TaxId field. +func (o *BankAccountDetail) SetTaxId(v string) { + o.TaxId = &v +} + +// GetUrlForVerification returns the UrlForVerification field value if set, zero value otherwise. +func (o *BankAccountDetail) GetUrlForVerification() string { + if o == nil || o.UrlForVerification == nil { + var ret string + return ret + } + return *o.UrlForVerification +} + +// GetUrlForVerificationOk returns a tuple with the UrlForVerification field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BankAccountDetail) GetUrlForVerificationOk() (*string, bool) { + if o == nil || o.UrlForVerification == nil { + return nil, false + } + return o.UrlForVerification, true +} + +// HasUrlForVerification returns a boolean if a field has been set. +func (o *BankAccountDetail) HasUrlForVerification() bool { + if o != nil && o.UrlForVerification != nil { + return true + } + + return false +} + +// SetUrlForVerification gets a reference to the given string and assigns it to the UrlForVerification field. +func (o *BankAccountDetail) SetUrlForVerification(v string) { + o.UrlForVerification = &v +} + +func (o BankAccountDetail) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.AccountNumber != nil { + toSerialize["accountNumber"] = o.AccountNumber + } + if o.AccountType != nil { + toSerialize["accountType"] = o.AccountType + } + if o.BankAccountName != nil { + toSerialize["bankAccountName"] = o.BankAccountName + } + if o.BankAccountReference != nil { + toSerialize["bankAccountReference"] = o.BankAccountReference + } + if o.BankAccountUUID != nil { + toSerialize["bankAccountUUID"] = o.BankAccountUUID + } + if o.BankBicSwift != nil { + toSerialize["bankBicSwift"] = o.BankBicSwift + } + if o.BankCity != nil { + toSerialize["bankCity"] = o.BankCity + } + if o.BankCode != nil { + toSerialize["bankCode"] = o.BankCode + } + if o.BankName != nil { + toSerialize["bankName"] = o.BankName + } + if o.BranchCode != nil { + toSerialize["branchCode"] = o.BranchCode + } + if o.CheckCode != nil { + toSerialize["checkCode"] = o.CheckCode + } + if o.CountryCode != nil { + toSerialize["countryCode"] = o.CountryCode + } + if o.CurrencyCode != nil { + toSerialize["currencyCode"] = o.CurrencyCode + } + if o.Iban != nil { + toSerialize["iban"] = o.Iban + } + if o.OwnerCity != nil { + toSerialize["ownerCity"] = o.OwnerCity + } + if o.OwnerCountryCode != nil { + toSerialize["ownerCountryCode"] = o.OwnerCountryCode + } + if o.OwnerDateOfBirth != nil { + toSerialize["ownerDateOfBirth"] = o.OwnerDateOfBirth + } + if o.OwnerHouseNumberOrName != nil { + toSerialize["ownerHouseNumberOrName"] = o.OwnerHouseNumberOrName + } + if o.OwnerName != nil { + toSerialize["ownerName"] = o.OwnerName + } + if o.OwnerNationality != nil { + toSerialize["ownerNationality"] = o.OwnerNationality + } + if o.OwnerPostalCode != nil { + toSerialize["ownerPostalCode"] = o.OwnerPostalCode + } + if o.OwnerState != nil { + toSerialize["ownerState"] = o.OwnerState + } + if o.OwnerStreet != nil { + toSerialize["ownerStreet"] = o.OwnerStreet + } + if o.PrimaryAccount != nil { + toSerialize["primaryAccount"] = o.PrimaryAccount + } + if o.TaxId != nil { + toSerialize["taxId"] = o.TaxId + } + if o.UrlForVerification != nil { + toSerialize["urlForVerification"] = o.UrlForVerification + } + return json.Marshal(toSerialize) +} + +type NullableBankAccountDetail struct { + value *BankAccountDetail + isSet bool +} + +func (v NullableBankAccountDetail) Get() *BankAccountDetail { + return v.value +} + +func (v *NullableBankAccountDetail) Set(val *BankAccountDetail) { + v.value = val + v.isSet = true +} + +func (v NullableBankAccountDetail) IsSet() bool { + return v.isSet +} + +func (v *NullableBankAccountDetail) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableBankAccountDetail(val *BankAccountDetail) *NullableBankAccountDetail { + return &NullableBankAccountDetail{value: val, isSet: true} +} + +func (v NullableBankAccountDetail) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableBankAccountDetail) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_beneficiary_setup_notification.go b/src/platformsnotificationevents/model_beneficiary_setup_notification.go new file mode 100644 index 000000000..245e7c297 --- /dev/null +++ b/src/platformsnotificationevents/model_beneficiary_setup_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// BeneficiarySetupNotification struct for BeneficiarySetupNotification +type BeneficiarySetupNotification struct { + Content BeneficiarySetupNotificationContent `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewBeneficiarySetupNotification instantiates a new BeneficiarySetupNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewBeneficiarySetupNotification(content BeneficiarySetupNotificationContent, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *BeneficiarySetupNotification { + this := BeneficiarySetupNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewBeneficiarySetupNotificationWithDefaults instantiates a new BeneficiarySetupNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewBeneficiarySetupNotificationWithDefaults() *BeneficiarySetupNotification { + this := BeneficiarySetupNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *BeneficiarySetupNotification) GetContent() BeneficiarySetupNotificationContent { + if o == nil { + var ret BeneficiarySetupNotificationContent + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotification) GetContentOk() (*BeneficiarySetupNotificationContent, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *BeneficiarySetupNotification) SetContent(v BeneficiarySetupNotificationContent) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *BeneficiarySetupNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *BeneficiarySetupNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *BeneficiarySetupNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *BeneficiarySetupNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *BeneficiarySetupNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *BeneficiarySetupNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *BeneficiarySetupNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *BeneficiarySetupNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *BeneficiarySetupNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *BeneficiarySetupNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *BeneficiarySetupNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *BeneficiarySetupNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *BeneficiarySetupNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o BeneficiarySetupNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableBeneficiarySetupNotification struct { + value *BeneficiarySetupNotification + isSet bool +} + +func (v NullableBeneficiarySetupNotification) Get() *BeneficiarySetupNotification { + return v.value +} + +func (v *NullableBeneficiarySetupNotification) Set(val *BeneficiarySetupNotification) { + v.value = val + v.isSet = true +} + +func (v NullableBeneficiarySetupNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableBeneficiarySetupNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableBeneficiarySetupNotification(val *BeneficiarySetupNotification) *NullableBeneficiarySetupNotification { + return &NullableBeneficiarySetupNotification{value: val, isSet: true} +} + +func (v NullableBeneficiarySetupNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableBeneficiarySetupNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_beneficiary_setup_notification_content.go b/src/platformsnotificationevents/model_beneficiary_setup_notification_content.go new file mode 100644 index 000000000..73882c2f0 --- /dev/null +++ b/src/platformsnotificationevents/model_beneficiary_setup_notification_content.go @@ -0,0 +1,305 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// BeneficiarySetupNotificationContent struct for BeneficiarySetupNotificationContent +type BeneficiarySetupNotificationContent struct { + // The code of the beneficiary account. + DestinationAccountCode string `json:"destinationAccountCode"` + // The code of the beneficiary Account Holder. + DestinationAccountHolderCode string `json:"destinationAccountHolderCode"` + // A listing of the invalid fields which have caused the Setup Beneficiary request to fail. If this is empty, the Setup Beneficiary request has succeeded. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + // The reference provided by the merchant. + MerchantReference *string `json:"merchantReference,omitempty"` + // The code of the benefactor account. + SourceAccountCode string `json:"sourceAccountCode"` + // The code of the benefactor Account Holder. + SourceAccountHolderCode string `json:"sourceAccountHolderCode"` + // The date on which the beneficiary was set up and funds transferred from benefactor to beneficiary. + TransferDate time.Time `json:"transferDate"` +} + +// NewBeneficiarySetupNotificationContent instantiates a new BeneficiarySetupNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewBeneficiarySetupNotificationContent(destinationAccountCode string, destinationAccountHolderCode string, sourceAccountCode string, sourceAccountHolderCode string, transferDate time.Time, ) *BeneficiarySetupNotificationContent { + this := BeneficiarySetupNotificationContent{} + this.DestinationAccountCode = destinationAccountCode + this.DestinationAccountHolderCode = destinationAccountHolderCode + this.SourceAccountCode = sourceAccountCode + this.SourceAccountHolderCode = sourceAccountHolderCode + this.TransferDate = transferDate + return &this +} + +// NewBeneficiarySetupNotificationContentWithDefaults instantiates a new BeneficiarySetupNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewBeneficiarySetupNotificationContentWithDefaults() *BeneficiarySetupNotificationContent { + this := BeneficiarySetupNotificationContent{} + return &this +} + +// GetDestinationAccountCode returns the DestinationAccountCode field value +func (o *BeneficiarySetupNotificationContent) GetDestinationAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.DestinationAccountCode +} + +// GetDestinationAccountCodeOk returns a tuple with the DestinationAccountCode field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotificationContent) GetDestinationAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.DestinationAccountCode, true +} + +// SetDestinationAccountCode sets field value +func (o *BeneficiarySetupNotificationContent) SetDestinationAccountCode(v string) { + o.DestinationAccountCode = v +} + +// GetDestinationAccountHolderCode returns the DestinationAccountHolderCode field value +func (o *BeneficiarySetupNotificationContent) GetDestinationAccountHolderCode() string { + if o == nil { + var ret string + return ret + } + + return o.DestinationAccountHolderCode +} + +// GetDestinationAccountHolderCodeOk returns a tuple with the DestinationAccountHolderCode field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotificationContent) GetDestinationAccountHolderCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.DestinationAccountHolderCode, true +} + +// SetDestinationAccountHolderCode sets field value +func (o *BeneficiarySetupNotificationContent) SetDestinationAccountHolderCode(v string) { + o.DestinationAccountHolderCode = v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *BeneficiarySetupNotificationContent) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotificationContent) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *BeneficiarySetupNotificationContent) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *BeneficiarySetupNotificationContent) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetMerchantReference returns the MerchantReference field value if set, zero value otherwise. +func (o *BeneficiarySetupNotificationContent) GetMerchantReference() string { + if o == nil || o.MerchantReference == nil { + var ret string + return ret + } + return *o.MerchantReference +} + +// GetMerchantReferenceOk returns a tuple with the MerchantReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotificationContent) GetMerchantReferenceOk() (*string, bool) { + if o == nil || o.MerchantReference == nil { + return nil, false + } + return o.MerchantReference, true +} + +// HasMerchantReference returns a boolean if a field has been set. +func (o *BeneficiarySetupNotificationContent) HasMerchantReference() bool { + if o != nil && o.MerchantReference != nil { + return true + } + + return false +} + +// SetMerchantReference gets a reference to the given string and assigns it to the MerchantReference field. +func (o *BeneficiarySetupNotificationContent) SetMerchantReference(v string) { + o.MerchantReference = &v +} + +// GetSourceAccountCode returns the SourceAccountCode field value +func (o *BeneficiarySetupNotificationContent) GetSourceAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.SourceAccountCode +} + +// GetSourceAccountCodeOk returns a tuple with the SourceAccountCode field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotificationContent) GetSourceAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.SourceAccountCode, true +} + +// SetSourceAccountCode sets field value +func (o *BeneficiarySetupNotificationContent) SetSourceAccountCode(v string) { + o.SourceAccountCode = v +} + +// GetSourceAccountHolderCode returns the SourceAccountHolderCode field value +func (o *BeneficiarySetupNotificationContent) GetSourceAccountHolderCode() string { + if o == nil { + var ret string + return ret + } + + return o.SourceAccountHolderCode +} + +// GetSourceAccountHolderCodeOk returns a tuple with the SourceAccountHolderCode field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotificationContent) GetSourceAccountHolderCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.SourceAccountHolderCode, true +} + +// SetSourceAccountHolderCode sets field value +func (o *BeneficiarySetupNotificationContent) SetSourceAccountHolderCode(v string) { + o.SourceAccountHolderCode = v +} + +// GetTransferDate returns the TransferDate field value +func (o *BeneficiarySetupNotificationContent) GetTransferDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.TransferDate +} + +// GetTransferDateOk returns a tuple with the TransferDate field value +// and a boolean to check if the value has been set. +func (o *BeneficiarySetupNotificationContent) GetTransferDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.TransferDate, true +} + +// SetTransferDate sets field value +func (o *BeneficiarySetupNotificationContent) SetTransferDate(v time.Time) { + o.TransferDate = v +} + +func (o BeneficiarySetupNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["destinationAccountCode"] = o.DestinationAccountCode + } + if true { + toSerialize["destinationAccountHolderCode"] = o.DestinationAccountHolderCode + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if o.MerchantReference != nil { + toSerialize["merchantReference"] = o.MerchantReference + } + if true { + toSerialize["sourceAccountCode"] = o.SourceAccountCode + } + if true { + toSerialize["sourceAccountHolderCode"] = o.SourceAccountHolderCode + } + if true { + toSerialize["transferDate"] = o.TransferDate + } + return json.Marshal(toSerialize) +} + +type NullableBeneficiarySetupNotificationContent struct { + value *BeneficiarySetupNotificationContent + isSet bool +} + +func (v NullableBeneficiarySetupNotificationContent) Get() *BeneficiarySetupNotificationContent { + return v.value +} + +func (v *NullableBeneficiarySetupNotificationContent) Set(val *BeneficiarySetupNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableBeneficiarySetupNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableBeneficiarySetupNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableBeneficiarySetupNotificationContent(val *BeneficiarySetupNotificationContent) *NullableBeneficiarySetupNotificationContent { + return &NullableBeneficiarySetupNotificationContent{value: val, isSet: true} +} + +func (v NullableBeneficiarySetupNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableBeneficiarySetupNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_business_details.go b/src/platformsnotificationevents/model_business_details.go new file mode 100644 index 000000000..ee3bc66a6 --- /dev/null +++ b/src/platformsnotificationevents/model_business_details.go @@ -0,0 +1,376 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// BusinessDetails struct for BusinessDetails +type BusinessDetails struct { + // The registered name of the company (if it differs from the legal name of the company). + DoingBusinessAs *string `json:"doingBusinessAs,omitempty"` + // The legal name of the company. + LegalBusinessName *string `json:"legalBusinessName,omitempty"` + // The registration number of the company. + RegistrationNumber *string `json:"registrationNumber,omitempty"` + // Each of the shareholders associated with the company. Each array entry should represent one shareholder. + Shareholders *[]ShareholderContact `json:"shareholders,omitempty"` + // Market Identifier Code (MIC). + StockExchange *string `json:"stockExchange,omitempty"` + // International Securities Identification Number (ISIN). + StockNumber *string `json:"stockNumber,omitempty"` + // Stock Ticker symbol. + StockTicker *string `json:"stockTicker,omitempty"` + // The tax ID of the company. + TaxId *string `json:"taxId,omitempty"` +} + +// NewBusinessDetails instantiates a new BusinessDetails object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewBusinessDetails() *BusinessDetails { + this := BusinessDetails{} + return &this +} + +// NewBusinessDetailsWithDefaults instantiates a new BusinessDetails object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewBusinessDetailsWithDefaults() *BusinessDetails { + this := BusinessDetails{} + return &this +} + +// GetDoingBusinessAs returns the DoingBusinessAs field value if set, zero value otherwise. +func (o *BusinessDetails) GetDoingBusinessAs() string { + if o == nil || o.DoingBusinessAs == nil { + var ret string + return ret + } + return *o.DoingBusinessAs +} + +// GetDoingBusinessAsOk returns a tuple with the DoingBusinessAs field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BusinessDetails) GetDoingBusinessAsOk() (*string, bool) { + if o == nil || o.DoingBusinessAs == nil { + return nil, false + } + return o.DoingBusinessAs, true +} + +// HasDoingBusinessAs returns a boolean if a field has been set. +func (o *BusinessDetails) HasDoingBusinessAs() bool { + if o != nil && o.DoingBusinessAs != nil { + return true + } + + return false +} + +// SetDoingBusinessAs gets a reference to the given string and assigns it to the DoingBusinessAs field. +func (o *BusinessDetails) SetDoingBusinessAs(v string) { + o.DoingBusinessAs = &v +} + +// GetLegalBusinessName returns the LegalBusinessName field value if set, zero value otherwise. +func (o *BusinessDetails) GetLegalBusinessName() string { + if o == nil || o.LegalBusinessName == nil { + var ret string + return ret + } + return *o.LegalBusinessName +} + +// GetLegalBusinessNameOk returns a tuple with the LegalBusinessName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BusinessDetails) GetLegalBusinessNameOk() (*string, bool) { + if o == nil || o.LegalBusinessName == nil { + return nil, false + } + return o.LegalBusinessName, true +} + +// HasLegalBusinessName returns a boolean if a field has been set. +func (o *BusinessDetails) HasLegalBusinessName() bool { + if o != nil && o.LegalBusinessName != nil { + return true + } + + return false +} + +// SetLegalBusinessName gets a reference to the given string and assigns it to the LegalBusinessName field. +func (o *BusinessDetails) SetLegalBusinessName(v string) { + o.LegalBusinessName = &v +} + +// GetRegistrationNumber returns the RegistrationNumber field value if set, zero value otherwise. +func (o *BusinessDetails) GetRegistrationNumber() string { + if o == nil || o.RegistrationNumber == nil { + var ret string + return ret + } + return *o.RegistrationNumber +} + +// GetRegistrationNumberOk returns a tuple with the RegistrationNumber field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BusinessDetails) GetRegistrationNumberOk() (*string, bool) { + if o == nil || o.RegistrationNumber == nil { + return nil, false + } + return o.RegistrationNumber, true +} + +// HasRegistrationNumber returns a boolean if a field has been set. +func (o *BusinessDetails) HasRegistrationNumber() bool { + if o != nil && o.RegistrationNumber != nil { + return true + } + + return false +} + +// SetRegistrationNumber gets a reference to the given string and assigns it to the RegistrationNumber field. +func (o *BusinessDetails) SetRegistrationNumber(v string) { + o.RegistrationNumber = &v +} + +// GetShareholders returns the Shareholders field value if set, zero value otherwise. +func (o *BusinessDetails) GetShareholders() []ShareholderContact { + if o == nil || o.Shareholders == nil { + var ret []ShareholderContact + return ret + } + return *o.Shareholders +} + +// GetShareholdersOk returns a tuple with the Shareholders field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BusinessDetails) GetShareholdersOk() (*[]ShareholderContact, bool) { + if o == nil || o.Shareholders == nil { + return nil, false + } + return o.Shareholders, true +} + +// HasShareholders returns a boolean if a field has been set. +func (o *BusinessDetails) HasShareholders() bool { + if o != nil && o.Shareholders != nil { + return true + } + + return false +} + +// SetShareholders gets a reference to the given []ShareholderContact and assigns it to the Shareholders field. +func (o *BusinessDetails) SetShareholders(v []ShareholderContact) { + o.Shareholders = &v +} + +// GetStockExchange returns the StockExchange field value if set, zero value otherwise. +func (o *BusinessDetails) GetStockExchange() string { + if o == nil || o.StockExchange == nil { + var ret string + return ret + } + return *o.StockExchange +} + +// GetStockExchangeOk returns a tuple with the StockExchange field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BusinessDetails) GetStockExchangeOk() (*string, bool) { + if o == nil || o.StockExchange == nil { + return nil, false + } + return o.StockExchange, true +} + +// HasStockExchange returns a boolean if a field has been set. +func (o *BusinessDetails) HasStockExchange() bool { + if o != nil && o.StockExchange != nil { + return true + } + + return false +} + +// SetStockExchange gets a reference to the given string and assigns it to the StockExchange field. +func (o *BusinessDetails) SetStockExchange(v string) { + o.StockExchange = &v +} + +// GetStockNumber returns the StockNumber field value if set, zero value otherwise. +func (o *BusinessDetails) GetStockNumber() string { + if o == nil || o.StockNumber == nil { + var ret string + return ret + } + return *o.StockNumber +} + +// GetStockNumberOk returns a tuple with the StockNumber field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BusinessDetails) GetStockNumberOk() (*string, bool) { + if o == nil || o.StockNumber == nil { + return nil, false + } + return o.StockNumber, true +} + +// HasStockNumber returns a boolean if a field has been set. +func (o *BusinessDetails) HasStockNumber() bool { + if o != nil && o.StockNumber != nil { + return true + } + + return false +} + +// SetStockNumber gets a reference to the given string and assigns it to the StockNumber field. +func (o *BusinessDetails) SetStockNumber(v string) { + o.StockNumber = &v +} + +// GetStockTicker returns the StockTicker field value if set, zero value otherwise. +func (o *BusinessDetails) GetStockTicker() string { + if o == nil || o.StockTicker == nil { + var ret string + return ret + } + return *o.StockTicker +} + +// GetStockTickerOk returns a tuple with the StockTicker field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BusinessDetails) GetStockTickerOk() (*string, bool) { + if o == nil || o.StockTicker == nil { + return nil, false + } + return o.StockTicker, true +} + +// HasStockTicker returns a boolean if a field has been set. +func (o *BusinessDetails) HasStockTicker() bool { + if o != nil && o.StockTicker != nil { + return true + } + + return false +} + +// SetStockTicker gets a reference to the given string and assigns it to the StockTicker field. +func (o *BusinessDetails) SetStockTicker(v string) { + o.StockTicker = &v +} + +// GetTaxId returns the TaxId field value if set, zero value otherwise. +func (o *BusinessDetails) GetTaxId() string { + if o == nil || o.TaxId == nil { + var ret string + return ret + } + return *o.TaxId +} + +// GetTaxIdOk returns a tuple with the TaxId field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *BusinessDetails) GetTaxIdOk() (*string, bool) { + if o == nil || o.TaxId == nil { + return nil, false + } + return o.TaxId, true +} + +// HasTaxId returns a boolean if a field has been set. +func (o *BusinessDetails) HasTaxId() bool { + if o != nil && o.TaxId != nil { + return true + } + + return false +} + +// SetTaxId gets a reference to the given string and assigns it to the TaxId field. +func (o *BusinessDetails) SetTaxId(v string) { + o.TaxId = &v +} + +func (o BusinessDetails) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DoingBusinessAs != nil { + toSerialize["doingBusinessAs"] = o.DoingBusinessAs + } + if o.LegalBusinessName != nil { + toSerialize["legalBusinessName"] = o.LegalBusinessName + } + if o.RegistrationNumber != nil { + toSerialize["registrationNumber"] = o.RegistrationNumber + } + if o.Shareholders != nil { + toSerialize["shareholders"] = o.Shareholders + } + if o.StockExchange != nil { + toSerialize["stockExchange"] = o.StockExchange + } + if o.StockNumber != nil { + toSerialize["stockNumber"] = o.StockNumber + } + if o.StockTicker != nil { + toSerialize["stockTicker"] = o.StockTicker + } + if o.TaxId != nil { + toSerialize["taxId"] = o.TaxId + } + return json.Marshal(toSerialize) +} + +type NullableBusinessDetails struct { + value *BusinessDetails + isSet bool +} + +func (v NullableBusinessDetails) Get() *BusinessDetails { + return v.value +} + +func (v *NullableBusinessDetails) Set(val *BusinessDetails) { + v.value = val + v.isSet = true +} + +func (v NullableBusinessDetails) IsSet() bool { + return v.isSet +} + +func (v *NullableBusinessDetails) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableBusinessDetails(val *BusinessDetails) *NullableBusinessDetails { + return &NullableBusinessDetails{value: val, isSet: true} +} + +func (v NullableBusinessDetails) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableBusinessDetails) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_close_account_response.go b/src/platformsnotificationevents/model_close_account_response.go new file mode 100644 index 000000000..bd02bcf1f --- /dev/null +++ b/src/platformsnotificationevents/model_close_account_response.go @@ -0,0 +1,258 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// CloseAccountResponse struct for CloseAccountResponse +type CloseAccountResponse struct { + // The account code of the account that is closed. + AccountCode *string `json:"accountCode,omitempty"` + // 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"` + // The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`. + Status string `json:"status"` +} + +// NewCloseAccountResponse instantiates a new CloseAccountResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCloseAccountResponse(status string, ) *CloseAccountResponse { + this := CloseAccountResponse{} + this.Status = status + return &this +} + +// NewCloseAccountResponseWithDefaults instantiates a new CloseAccountResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCloseAccountResponseWithDefaults() *CloseAccountResponse { + this := CloseAccountResponse{} + return &this +} + +// GetAccountCode returns the AccountCode field value if set, zero value otherwise. +func (o *CloseAccountResponse) GetAccountCode() string { + if o == nil || o.AccountCode == nil { + var ret string + return ret + } + return *o.AccountCode +} + +// GetAccountCodeOk returns a tuple with the AccountCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CloseAccountResponse) GetAccountCodeOk() (*string, bool) { + if o == nil || o.AccountCode == nil { + return nil, false + } + return o.AccountCode, true +} + +// HasAccountCode returns a boolean if a field has been set. +func (o *CloseAccountResponse) HasAccountCode() bool { + if o != nil && o.AccountCode != nil { + return true + } + + return false +} + +// SetAccountCode gets a reference to the given string and assigns it to the AccountCode field. +func (o *CloseAccountResponse) SetAccountCode(v string) { + o.AccountCode = &v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *CloseAccountResponse) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CloseAccountResponse) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *CloseAccountResponse) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *CloseAccountResponse) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetPspReference returns the PspReference field value if set, zero value otherwise. +func (o *CloseAccountResponse) GetPspReference() string { + if o == nil || o.PspReference == nil { + var ret string + return ret + } + return *o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CloseAccountResponse) GetPspReferenceOk() (*string, bool) { + if o == nil || o.PspReference == nil { + return nil, false + } + return o.PspReference, true +} + +// HasPspReference returns a boolean if a field has been set. +func (o *CloseAccountResponse) HasPspReference() bool { + if o != nil && o.PspReference != nil { + return true + } + + return false +} + +// SetPspReference gets a reference to the given string and assigns it to the PspReference field. +func (o *CloseAccountResponse) SetPspReference(v string) { + o.PspReference = &v +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *CloseAccountResponse) GetResultCode() string { + if o == nil || o.ResultCode == nil { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CloseAccountResponse) GetResultCodeOk() (*string, bool) { + if o == nil || o.ResultCode == nil { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *CloseAccountResponse) HasResultCode() bool { + if o != nil && o.ResultCode != nil { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *CloseAccountResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetStatus returns the Status field value +func (o *CloseAccountResponse) GetStatus() string { + if o == nil { + var ret string + return ret + } + + return o.Status +} + +// GetStatusOk returns a tuple with the Status field value +// and a boolean to check if the value has been set. +func (o *CloseAccountResponse) GetStatusOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Status, true +} + +// SetStatus sets field value +func (o *CloseAccountResponse) SetStatus(v string) { + o.Status = v +} + +func (o CloseAccountResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.AccountCode != nil { + toSerialize["accountCode"] = o.AccountCode + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if o.PspReference != nil { + toSerialize["pspReference"] = o.PspReference + } + if o.ResultCode != nil { + toSerialize["resultCode"] = o.ResultCode + } + if true { + toSerialize["status"] = o.Status + } + return json.Marshal(toSerialize) +} + +type NullableCloseAccountResponse struct { + value *CloseAccountResponse + isSet bool +} + +func (v NullableCloseAccountResponse) Get() *CloseAccountResponse { + return v.value +} + +func (v *NullableCloseAccountResponse) Set(val *CloseAccountResponse) { + v.value = val + v.isSet = true +} + +func (v NullableCloseAccountResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableCloseAccountResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCloseAccountResponse(val *CloseAccountResponse) *NullableCloseAccountResponse { + return &NullableCloseAccountResponse{value: val, isSet: true} +} + +func (v NullableCloseAccountResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCloseAccountResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_compensate_negative_balance_notification.go b/src/platformsnotificationevents/model_compensate_negative_balance_notification.go new file mode 100644 index 000000000..0212a0eeb --- /dev/null +++ b/src/platformsnotificationevents/model_compensate_negative_balance_notification.go @@ -0,0 +1,303 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// CompensateNegativeBalanceNotification struct for CompensateNegativeBalanceNotification +type CompensateNegativeBalanceNotification struct { + Content *CompensateNegativeBalanceNotificationContent `json:"content,omitempty"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewCompensateNegativeBalanceNotification instantiates a new CompensateNegativeBalanceNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCompensateNegativeBalanceNotification(eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *CompensateNegativeBalanceNotification { + this := CompensateNegativeBalanceNotification{} + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewCompensateNegativeBalanceNotificationWithDefaults instantiates a new CompensateNegativeBalanceNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCompensateNegativeBalanceNotificationWithDefaults() *CompensateNegativeBalanceNotification { + this := CompensateNegativeBalanceNotification{} + return &this +} + +// GetContent returns the Content field value if set, zero value otherwise. +func (o *CompensateNegativeBalanceNotification) GetContent() CompensateNegativeBalanceNotificationContent { + if o == nil || o.Content == nil { + var ret CompensateNegativeBalanceNotificationContent + return ret + } + return *o.Content +} + +// GetContentOk returns a tuple with the Content field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotification) GetContentOk() (*CompensateNegativeBalanceNotificationContent, bool) { + if o == nil || o.Content == nil { + return nil, false + } + return o.Content, true +} + +// HasContent returns a boolean if a field has been set. +func (o *CompensateNegativeBalanceNotification) HasContent() bool { + if o != nil && o.Content != nil { + return true + } + + return false +} + +// SetContent gets a reference to the given CompensateNegativeBalanceNotificationContent and assigns it to the Content field. +func (o *CompensateNegativeBalanceNotification) SetContent(v CompensateNegativeBalanceNotificationContent) { + o.Content = &v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *CompensateNegativeBalanceNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *CompensateNegativeBalanceNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *CompensateNegativeBalanceNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *CompensateNegativeBalanceNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *CompensateNegativeBalanceNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *CompensateNegativeBalanceNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *CompensateNegativeBalanceNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *CompensateNegativeBalanceNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *CompensateNegativeBalanceNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *CompensateNegativeBalanceNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *CompensateNegativeBalanceNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *CompensateNegativeBalanceNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *CompensateNegativeBalanceNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o CompensateNegativeBalanceNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Content != nil { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableCompensateNegativeBalanceNotification struct { + value *CompensateNegativeBalanceNotification + isSet bool +} + +func (v NullableCompensateNegativeBalanceNotification) Get() *CompensateNegativeBalanceNotification { + return v.value +} + +func (v *NullableCompensateNegativeBalanceNotification) Set(val *CompensateNegativeBalanceNotification) { + v.value = val + v.isSet = true +} + +func (v NullableCompensateNegativeBalanceNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableCompensateNegativeBalanceNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCompensateNegativeBalanceNotification(val *CompensateNegativeBalanceNotification) *NullableCompensateNegativeBalanceNotification { + return &NullableCompensateNegativeBalanceNotification{value: val, isSet: true} +} + +func (v NullableCompensateNegativeBalanceNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCompensateNegativeBalanceNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_compensate_negative_balance_notification_content.go b/src/platformsnotificationevents/model_compensate_negative_balance_notification_content.go new file mode 100644 index 000000000..6def86255 --- /dev/null +++ b/src/platformsnotificationevents/model_compensate_negative_balance_notification_content.go @@ -0,0 +1,110 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// CompensateNegativeBalanceNotificationContent struct for CompensateNegativeBalanceNotificationContent +type CompensateNegativeBalanceNotificationContent struct { + // A list of the negative balances compensated. + Records []CompensateNegativeBalanceNotificationRecord `json:"records"` +} + +// NewCompensateNegativeBalanceNotificationContent instantiates a new CompensateNegativeBalanceNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCompensateNegativeBalanceNotificationContent(records []CompensateNegativeBalanceNotificationRecord, ) *CompensateNegativeBalanceNotificationContent { + this := CompensateNegativeBalanceNotificationContent{} + this.Records = records + return &this +} + +// NewCompensateNegativeBalanceNotificationContentWithDefaults instantiates a new CompensateNegativeBalanceNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCompensateNegativeBalanceNotificationContentWithDefaults() *CompensateNegativeBalanceNotificationContent { + this := CompensateNegativeBalanceNotificationContent{} + return &this +} + +// GetRecords returns the Records field value +func (o *CompensateNegativeBalanceNotificationContent) GetRecords() []CompensateNegativeBalanceNotificationRecord { + if o == nil { + var ret []CompensateNegativeBalanceNotificationRecord + return ret + } + + return o.Records +} + +// GetRecordsOk returns a tuple with the Records field value +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotificationContent) GetRecordsOk() (*[]CompensateNegativeBalanceNotificationRecord, bool) { + if o == nil { + return nil, false + } + return &o.Records, true +} + +// SetRecords sets field value +func (o *CompensateNegativeBalanceNotificationContent) SetRecords(v []CompensateNegativeBalanceNotificationRecord) { + o.Records = v +} + +func (o CompensateNegativeBalanceNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["records"] = o.Records + } + return json.Marshal(toSerialize) +} + +type NullableCompensateNegativeBalanceNotificationContent struct { + value *CompensateNegativeBalanceNotificationContent + isSet bool +} + +func (v NullableCompensateNegativeBalanceNotificationContent) Get() *CompensateNegativeBalanceNotificationContent { + return v.value +} + +func (v *NullableCompensateNegativeBalanceNotificationContent) Set(val *CompensateNegativeBalanceNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableCompensateNegativeBalanceNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableCompensateNegativeBalanceNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCompensateNegativeBalanceNotificationContent(val *CompensateNegativeBalanceNotificationContent) *NullableCompensateNegativeBalanceNotificationContent { + return &NullableCompensateNegativeBalanceNotificationContent{value: val, isSet: true} +} + +func (v NullableCompensateNegativeBalanceNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCompensateNegativeBalanceNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_compensate_negative_balance_notification_record.go b/src/platformsnotificationevents/model_compensate_negative_balance_notification_record.go new file mode 100644 index 000000000..af7b4fa9b --- /dev/null +++ b/src/platformsnotificationevents/model_compensate_negative_balance_notification_record.go @@ -0,0 +1,170 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// CompensateNegativeBalanceNotificationRecord struct for CompensateNegativeBalanceNotificationRecord +type CompensateNegativeBalanceNotificationRecord struct { + // The code of the account whose negative balance has been compensated. + AccountCode string `json:"accountCode"` + Amount Amount `json:"amount"` + // The date on which the compensation took place. + TransferDate time.Time `json:"transferDate"` +} + +// NewCompensateNegativeBalanceNotificationRecord instantiates a new CompensateNegativeBalanceNotificationRecord object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCompensateNegativeBalanceNotificationRecord(accountCode string, amount Amount, transferDate time.Time, ) *CompensateNegativeBalanceNotificationRecord { + this := CompensateNegativeBalanceNotificationRecord{} + this.AccountCode = accountCode + this.Amount = amount + this.TransferDate = transferDate + return &this +} + +// NewCompensateNegativeBalanceNotificationRecordWithDefaults instantiates a new CompensateNegativeBalanceNotificationRecord object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCompensateNegativeBalanceNotificationRecordWithDefaults() *CompensateNegativeBalanceNotificationRecord { + this := CompensateNegativeBalanceNotificationRecord{} + return &this +} + +// GetAccountCode returns the AccountCode field value +func (o *CompensateNegativeBalanceNotificationRecord) GetAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountCode +} + +// GetAccountCodeOk returns a tuple with the AccountCode field value +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotificationRecord) GetAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountCode, true +} + +// SetAccountCode sets field value +func (o *CompensateNegativeBalanceNotificationRecord) SetAccountCode(v string) { + o.AccountCode = v +} + +// GetAmount returns the Amount field value +func (o *CompensateNegativeBalanceNotificationRecord) GetAmount() Amount { + if o == nil { + var ret Amount + return ret + } + + return o.Amount +} + +// GetAmountOk returns a tuple with the Amount field value +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotificationRecord) GetAmountOk() (*Amount, bool) { + if o == nil { + return nil, false + } + return &o.Amount, true +} + +// SetAmount sets field value +func (o *CompensateNegativeBalanceNotificationRecord) SetAmount(v Amount) { + o.Amount = v +} + +// GetTransferDate returns the TransferDate field value +func (o *CompensateNegativeBalanceNotificationRecord) GetTransferDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.TransferDate +} + +// GetTransferDateOk returns a tuple with the TransferDate field value +// and a boolean to check if the value has been set. +func (o *CompensateNegativeBalanceNotificationRecord) GetTransferDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.TransferDate, true +} + +// SetTransferDate sets field value +func (o *CompensateNegativeBalanceNotificationRecord) SetTransferDate(v time.Time) { + o.TransferDate = v +} + +func (o CompensateNegativeBalanceNotificationRecord) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["accountCode"] = o.AccountCode + } + if true { + toSerialize["amount"] = o.Amount + } + if true { + toSerialize["transferDate"] = o.TransferDate + } + return json.Marshal(toSerialize) +} + +type NullableCompensateNegativeBalanceNotificationRecord struct { + value *CompensateNegativeBalanceNotificationRecord + isSet bool +} + +func (v NullableCompensateNegativeBalanceNotificationRecord) Get() *CompensateNegativeBalanceNotificationRecord { + return v.value +} + +func (v *NullableCompensateNegativeBalanceNotificationRecord) Set(val *CompensateNegativeBalanceNotificationRecord) { + v.value = val + v.isSet = true +} + +func (v NullableCompensateNegativeBalanceNotificationRecord) IsSet() bool { + return v.isSet +} + +func (v *NullableCompensateNegativeBalanceNotificationRecord) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCompensateNegativeBalanceNotificationRecord(val *CompensateNegativeBalanceNotificationRecord) *NullableCompensateNegativeBalanceNotificationRecord { + return &NullableCompensateNegativeBalanceNotificationRecord{value: val, isSet: true} +} + +func (v NullableCompensateNegativeBalanceNotificationRecord) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCompensateNegativeBalanceNotificationRecord) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_create_account_holder_response.go b/src/platformsnotificationevents/model_create_account_holder_response.go new file mode 100644 index 000000000..7f311af6a --- /dev/null +++ b/src/platformsnotificationevents/model_create_account_holder_response.go @@ -0,0 +1,486 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// CreateAccountHolderResponse struct for CreateAccountHolderResponse +type CreateAccountHolderResponse struct { + // The code of a new account created for the account holder. + AccountCode *string `json:"accountCode,omitempty"` + // The code of the new account holder. + AccountHolderCode string `json:"accountHolderCode"` + AccountHolderDetails AccountHolderDetails `json:"accountHolderDetails"` + AccountHolderStatus AccountHolderStatus `json:"accountHolderStatus"` + // The description of the new account holder. + Description *string `json:"description,omitempty"` + // A list of fields that caused the `/createAccountHolder` request to fail. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + // The type of legal entity of the new account holder. + LegalEntity string `json:"legalEntity"` + // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. + PrimaryCurrency *string `json:"primaryCurrency,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"` + Verification KYCVerificationResult `json:"verification"` + // The identifier of the profile that applies to this entity. + VerificationProfile *string `json:"verificationProfile,omitempty"` +} + +// NewCreateAccountHolderResponse instantiates a new CreateAccountHolderResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCreateAccountHolderResponse(accountHolderCode string, accountHolderDetails AccountHolderDetails, accountHolderStatus AccountHolderStatus, legalEntity string, verification KYCVerificationResult, ) *CreateAccountHolderResponse { + this := CreateAccountHolderResponse{} + this.AccountHolderCode = accountHolderCode + this.AccountHolderDetails = accountHolderDetails + this.AccountHolderStatus = accountHolderStatus + this.LegalEntity = legalEntity + this.Verification = verification + return &this +} + +// NewCreateAccountHolderResponseWithDefaults instantiates a new CreateAccountHolderResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCreateAccountHolderResponseWithDefaults() *CreateAccountHolderResponse { + this := CreateAccountHolderResponse{} + return &this +} + +// GetAccountCode returns the AccountCode field value if set, zero value otherwise. +func (o *CreateAccountHolderResponse) GetAccountCode() string { + if o == nil || o.AccountCode == nil { + var ret string + return ret + } + return *o.AccountCode +} + +// GetAccountCodeOk returns a tuple with the AccountCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetAccountCodeOk() (*string, bool) { + if o == nil || o.AccountCode == nil { + return nil, false + } + return o.AccountCode, true +} + +// HasAccountCode returns a boolean if a field has been set. +func (o *CreateAccountHolderResponse) HasAccountCode() bool { + if o != nil && o.AccountCode != nil { + return true + } + + return false +} + +// SetAccountCode gets a reference to the given string and assigns it to the AccountCode field. +func (o *CreateAccountHolderResponse) SetAccountCode(v string) { + o.AccountCode = &v +} + +// GetAccountHolderCode returns the AccountHolderCode field value +func (o *CreateAccountHolderResponse) GetAccountHolderCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountHolderCode +} + +// GetAccountHolderCodeOk returns a tuple with the AccountHolderCode field value +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetAccountHolderCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountHolderCode, true +} + +// SetAccountHolderCode sets field value +func (o *CreateAccountHolderResponse) SetAccountHolderCode(v string) { + o.AccountHolderCode = v +} + +// GetAccountHolderDetails returns the AccountHolderDetails field value +func (o *CreateAccountHolderResponse) GetAccountHolderDetails() AccountHolderDetails { + if o == nil { + var ret AccountHolderDetails + return ret + } + + return o.AccountHolderDetails +} + +// GetAccountHolderDetailsOk returns a tuple with the AccountHolderDetails field value +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetAccountHolderDetailsOk() (*AccountHolderDetails, bool) { + if o == nil { + return nil, false + } + return &o.AccountHolderDetails, true +} + +// SetAccountHolderDetails sets field value +func (o *CreateAccountHolderResponse) SetAccountHolderDetails(v AccountHolderDetails) { + o.AccountHolderDetails = v +} + +// GetAccountHolderStatus returns the AccountHolderStatus field value +func (o *CreateAccountHolderResponse) GetAccountHolderStatus() AccountHolderStatus { + if o == nil { + var ret AccountHolderStatus + return ret + } + + return o.AccountHolderStatus +} + +// GetAccountHolderStatusOk returns a tuple with the AccountHolderStatus field value +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetAccountHolderStatusOk() (*AccountHolderStatus, bool) { + if o == nil { + return nil, false + } + return &o.AccountHolderStatus, true +} + +// SetAccountHolderStatus sets field value +func (o *CreateAccountHolderResponse) SetAccountHolderStatus(v AccountHolderStatus) { + o.AccountHolderStatus = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *CreateAccountHolderResponse) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetDescriptionOk() (*string, bool) { + if o == nil || o.Description == nil { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *CreateAccountHolderResponse) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *CreateAccountHolderResponse) SetDescription(v string) { + o.Description = &v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *CreateAccountHolderResponse) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *CreateAccountHolderResponse) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *CreateAccountHolderResponse) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetLegalEntity returns the LegalEntity field value +func (o *CreateAccountHolderResponse) GetLegalEntity() string { + if o == nil { + var ret string + return ret + } + + return o.LegalEntity +} + +// GetLegalEntityOk returns a tuple with the LegalEntity field value +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetLegalEntityOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.LegalEntity, true +} + +// SetLegalEntity sets field value +func (o *CreateAccountHolderResponse) SetLegalEntity(v string) { + o.LegalEntity = v +} + +// GetPrimaryCurrency returns the PrimaryCurrency field value if set, zero value otherwise. +func (o *CreateAccountHolderResponse) GetPrimaryCurrency() string { + if o == nil || o.PrimaryCurrency == nil { + var ret string + return ret + } + return *o.PrimaryCurrency +} + +// GetPrimaryCurrencyOk returns a tuple with the PrimaryCurrency field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetPrimaryCurrencyOk() (*string, bool) { + if o == nil || o.PrimaryCurrency == nil { + return nil, false + } + return o.PrimaryCurrency, true +} + +// HasPrimaryCurrency returns a boolean if a field has been set. +func (o *CreateAccountHolderResponse) HasPrimaryCurrency() bool { + if o != nil && o.PrimaryCurrency != nil { + return true + } + + return false +} + +// SetPrimaryCurrency gets a reference to the given string and assigns it to the PrimaryCurrency field. +func (o *CreateAccountHolderResponse) SetPrimaryCurrency(v string) { + o.PrimaryCurrency = &v +} + +// GetPspReference returns the PspReference field value if set, zero value otherwise. +func (o *CreateAccountHolderResponse) GetPspReference() string { + if o == nil || o.PspReference == nil { + var ret string + return ret + } + return *o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetPspReferenceOk() (*string, bool) { + if o == nil || o.PspReference == nil { + return nil, false + } + return o.PspReference, true +} + +// HasPspReference returns a boolean if a field has been set. +func (o *CreateAccountHolderResponse) HasPspReference() bool { + if o != nil && o.PspReference != nil { + return true + } + + return false +} + +// SetPspReference gets a reference to the given string and assigns it to the PspReference field. +func (o *CreateAccountHolderResponse) SetPspReference(v string) { + o.PspReference = &v +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *CreateAccountHolderResponse) GetResultCode() string { + if o == nil || o.ResultCode == nil { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetResultCodeOk() (*string, bool) { + if o == nil || o.ResultCode == nil { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *CreateAccountHolderResponse) HasResultCode() bool { + if o != nil && o.ResultCode != nil { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *CreateAccountHolderResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetVerification returns the Verification field value +func (o *CreateAccountHolderResponse) GetVerification() KYCVerificationResult { + if o == nil { + var ret KYCVerificationResult + return ret + } + + return o.Verification +} + +// GetVerificationOk returns a tuple with the Verification field value +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetVerificationOk() (*KYCVerificationResult, bool) { + if o == nil { + return nil, false + } + return &o.Verification, true +} + +// SetVerification sets field value +func (o *CreateAccountHolderResponse) SetVerification(v KYCVerificationResult) { + o.Verification = v +} + +// GetVerificationProfile returns the VerificationProfile field value if set, zero value otherwise. +func (o *CreateAccountHolderResponse) GetVerificationProfile() string { + if o == nil || o.VerificationProfile == nil { + var ret string + return ret + } + return *o.VerificationProfile +} + +// GetVerificationProfileOk returns a tuple with the VerificationProfile field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountHolderResponse) GetVerificationProfileOk() (*string, bool) { + if o == nil || o.VerificationProfile == nil { + return nil, false + } + return o.VerificationProfile, true +} + +// HasVerificationProfile returns a boolean if a field has been set. +func (o *CreateAccountHolderResponse) HasVerificationProfile() bool { + if o != nil && o.VerificationProfile != nil { + return true + } + + return false +} + +// SetVerificationProfile gets a reference to the given string and assigns it to the VerificationProfile field. +func (o *CreateAccountHolderResponse) SetVerificationProfile(v string) { + o.VerificationProfile = &v +} + +func (o CreateAccountHolderResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.AccountCode != nil { + toSerialize["accountCode"] = o.AccountCode + } + if true { + toSerialize["accountHolderCode"] = o.AccountHolderCode + } + if true { + toSerialize["accountHolderDetails"] = o.AccountHolderDetails + } + if true { + toSerialize["accountHolderStatus"] = o.AccountHolderStatus + } + if o.Description != nil { + toSerialize["description"] = o.Description + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if true { + toSerialize["legalEntity"] = o.LegalEntity + } + if o.PrimaryCurrency != nil { + toSerialize["primaryCurrency"] = o.PrimaryCurrency + } + if o.PspReference != nil { + toSerialize["pspReference"] = o.PspReference + } + if o.ResultCode != nil { + toSerialize["resultCode"] = o.ResultCode + } + if true { + toSerialize["verification"] = o.Verification + } + if o.VerificationProfile != nil { + toSerialize["verificationProfile"] = o.VerificationProfile + } + return json.Marshal(toSerialize) +} + +type NullableCreateAccountHolderResponse struct { + value *CreateAccountHolderResponse + isSet bool +} + +func (v NullableCreateAccountHolderResponse) Get() *CreateAccountHolderResponse { + return v.value +} + +func (v *NullableCreateAccountHolderResponse) Set(val *CreateAccountHolderResponse) { + v.value = val + v.isSet = true +} + +func (v NullableCreateAccountHolderResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableCreateAccountHolderResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCreateAccountHolderResponse(val *CreateAccountHolderResponse) *NullableCreateAccountHolderResponse { + return &NullableCreateAccountHolderResponse{value: val, isSet: true} +} + +func (v NullableCreateAccountHolderResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCreateAccountHolderResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_create_account_response.go b/src/platformsnotificationevents/model_create_account_response.go new file mode 100644 index 000000000..f8dcadcdc --- /dev/null +++ b/src/platformsnotificationevents/model_create_account_response.go @@ -0,0 +1,501 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// CreateAccountResponse struct for CreateAccountResponse +type CreateAccountResponse struct { + // The code of the new account. + AccountCode string `json:"accountCode"` + // The code of the account holder. + AccountHolderCode string `json:"accountHolderCode"` + // The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + BankAccountUUID *string `json:"bankAccountUUID,omitempty"` + // The description of the account. + Description *string `json:"description,omitempty"` + // A list of fields that caused the `/createAccount` request to fail. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + Metadata *map[string]string `json:"metadata,omitempty"` + // The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + PayoutMethodCode *string `json:"payoutMethodCode,omitempty"` + PayoutSchedule *PayoutScheduleResponse `json:"payoutSchedule,omitempty"` + // Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + PayoutSpeed *string `json:"payoutSpeed,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"` + // The status of the account. >Permitted values: `Active`. + Status string `json:"status"` +} + +// NewCreateAccountResponse instantiates a new CreateAccountResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCreateAccountResponse(accountCode string, accountHolderCode string, status string, ) *CreateAccountResponse { + this := CreateAccountResponse{} + this.AccountCode = accountCode + this.AccountHolderCode = accountHolderCode + this.Status = status + return &this +} + +// NewCreateAccountResponseWithDefaults instantiates a new CreateAccountResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCreateAccountResponseWithDefaults() *CreateAccountResponse { + this := CreateAccountResponse{} + return &this +} + +// GetAccountCode returns the AccountCode field value +func (o *CreateAccountResponse) GetAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountCode +} + +// GetAccountCodeOk returns a tuple with the AccountCode field value +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountCode, true +} + +// SetAccountCode sets field value +func (o *CreateAccountResponse) SetAccountCode(v string) { + o.AccountCode = v +} + +// GetAccountHolderCode returns the AccountHolderCode field value +func (o *CreateAccountResponse) GetAccountHolderCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountHolderCode +} + +// GetAccountHolderCodeOk returns a tuple with the AccountHolderCode field value +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetAccountHolderCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountHolderCode, true +} + +// SetAccountHolderCode sets field value +func (o *CreateAccountResponse) SetAccountHolderCode(v string) { + o.AccountHolderCode = v +} + +// GetBankAccountUUID returns the BankAccountUUID field value if set, zero value otherwise. +func (o *CreateAccountResponse) GetBankAccountUUID() string { + if o == nil || o.BankAccountUUID == nil { + var ret string + return ret + } + return *o.BankAccountUUID +} + +// GetBankAccountUUIDOk returns a tuple with the BankAccountUUID field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetBankAccountUUIDOk() (*string, bool) { + if o == nil || o.BankAccountUUID == nil { + return nil, false + } + return o.BankAccountUUID, true +} + +// HasBankAccountUUID returns a boolean if a field has been set. +func (o *CreateAccountResponse) HasBankAccountUUID() bool { + if o != nil && o.BankAccountUUID != nil { + return true + } + + return false +} + +// SetBankAccountUUID gets a reference to the given string and assigns it to the BankAccountUUID field. +func (o *CreateAccountResponse) SetBankAccountUUID(v string) { + o.BankAccountUUID = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *CreateAccountResponse) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetDescriptionOk() (*string, bool) { + if o == nil || o.Description == nil { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *CreateAccountResponse) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *CreateAccountResponse) SetDescription(v string) { + o.Description = &v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *CreateAccountResponse) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *CreateAccountResponse) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *CreateAccountResponse) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetMetadata returns the Metadata field value if set, zero value otherwise. +func (o *CreateAccountResponse) GetMetadata() map[string]string { + if o == nil || o.Metadata == nil { + var ret map[string]string + return ret + } + return *o.Metadata +} + +// GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetMetadataOk() (*map[string]string, bool) { + if o == nil || o.Metadata == nil { + return nil, false + } + return o.Metadata, true +} + +// HasMetadata returns a boolean if a field has been set. +func (o *CreateAccountResponse) HasMetadata() bool { + if o != nil && o.Metadata != nil { + return true + } + + return false +} + +// SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field. +func (o *CreateAccountResponse) SetMetadata(v map[string]string) { + o.Metadata = &v +} + +// GetPayoutMethodCode returns the PayoutMethodCode field value if set, zero value otherwise. +func (o *CreateAccountResponse) GetPayoutMethodCode() string { + if o == nil || o.PayoutMethodCode == nil { + var ret string + return ret + } + return *o.PayoutMethodCode +} + +// GetPayoutMethodCodeOk returns a tuple with the PayoutMethodCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetPayoutMethodCodeOk() (*string, bool) { + if o == nil || o.PayoutMethodCode == nil { + return nil, false + } + return o.PayoutMethodCode, true +} + +// HasPayoutMethodCode returns a boolean if a field has been set. +func (o *CreateAccountResponse) HasPayoutMethodCode() bool { + if o != nil && o.PayoutMethodCode != nil { + return true + } + + return false +} + +// SetPayoutMethodCode gets a reference to the given string and assigns it to the PayoutMethodCode field. +func (o *CreateAccountResponse) SetPayoutMethodCode(v string) { + o.PayoutMethodCode = &v +} + +// GetPayoutSchedule returns the PayoutSchedule field value if set, zero value otherwise. +func (o *CreateAccountResponse) GetPayoutSchedule() PayoutScheduleResponse { + if o == nil || o.PayoutSchedule == nil { + var ret PayoutScheduleResponse + return ret + } + return *o.PayoutSchedule +} + +// GetPayoutScheduleOk returns a tuple with the PayoutSchedule field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetPayoutScheduleOk() (*PayoutScheduleResponse, bool) { + if o == nil || o.PayoutSchedule == nil { + return nil, false + } + return o.PayoutSchedule, true +} + +// HasPayoutSchedule returns a boolean if a field has been set. +func (o *CreateAccountResponse) HasPayoutSchedule() bool { + if o != nil && o.PayoutSchedule != nil { + return true + } + + return false +} + +// SetPayoutSchedule gets a reference to the given PayoutScheduleResponse and assigns it to the PayoutSchedule field. +func (o *CreateAccountResponse) SetPayoutSchedule(v PayoutScheduleResponse) { + o.PayoutSchedule = &v +} + +// GetPayoutSpeed returns the PayoutSpeed field value if set, zero value otherwise. +func (o *CreateAccountResponse) GetPayoutSpeed() string { + if o == nil || o.PayoutSpeed == nil { + var ret string + return ret + } + return *o.PayoutSpeed +} + +// GetPayoutSpeedOk returns a tuple with the PayoutSpeed field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetPayoutSpeedOk() (*string, bool) { + if o == nil || o.PayoutSpeed == nil { + return nil, false + } + return o.PayoutSpeed, true +} + +// HasPayoutSpeed returns a boolean if a field has been set. +func (o *CreateAccountResponse) HasPayoutSpeed() bool { + if o != nil && o.PayoutSpeed != nil { + return true + } + + return false +} + +// SetPayoutSpeed gets a reference to the given string and assigns it to the PayoutSpeed field. +func (o *CreateAccountResponse) SetPayoutSpeed(v string) { + o.PayoutSpeed = &v +} + +// GetPspReference returns the PspReference field value if set, zero value otherwise. +func (o *CreateAccountResponse) GetPspReference() string { + if o == nil || o.PspReference == nil { + var ret string + return ret + } + return *o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetPspReferenceOk() (*string, bool) { + if o == nil || o.PspReference == nil { + return nil, false + } + return o.PspReference, true +} + +// HasPspReference returns a boolean if a field has been set. +func (o *CreateAccountResponse) HasPspReference() bool { + if o != nil && o.PspReference != nil { + return true + } + + return false +} + +// SetPspReference gets a reference to the given string and assigns it to the PspReference field. +func (o *CreateAccountResponse) SetPspReference(v string) { + o.PspReference = &v +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *CreateAccountResponse) GetResultCode() string { + if o == nil || o.ResultCode == nil { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetResultCodeOk() (*string, bool) { + if o == nil || o.ResultCode == nil { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *CreateAccountResponse) HasResultCode() bool { + if o != nil && o.ResultCode != nil { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *CreateAccountResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetStatus returns the Status field value +func (o *CreateAccountResponse) GetStatus() string { + if o == nil { + var ret string + return ret + } + + return o.Status +} + +// GetStatusOk returns a tuple with the Status field value +// and a boolean to check if the value has been set. +func (o *CreateAccountResponse) GetStatusOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Status, true +} + +// SetStatus sets field value +func (o *CreateAccountResponse) SetStatus(v string) { + o.Status = v +} + +func (o CreateAccountResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["accountCode"] = o.AccountCode + } + if true { + toSerialize["accountHolderCode"] = o.AccountHolderCode + } + if o.BankAccountUUID != nil { + toSerialize["bankAccountUUID"] = o.BankAccountUUID + } + if o.Description != nil { + toSerialize["description"] = o.Description + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if o.Metadata != nil { + toSerialize["metadata"] = o.Metadata + } + if o.PayoutMethodCode != nil { + toSerialize["payoutMethodCode"] = o.PayoutMethodCode + } + if o.PayoutSchedule != nil { + toSerialize["payoutSchedule"] = o.PayoutSchedule + } + if o.PayoutSpeed != nil { + toSerialize["payoutSpeed"] = o.PayoutSpeed + } + if o.PspReference != nil { + toSerialize["pspReference"] = o.PspReference + } + if o.ResultCode != nil { + toSerialize["resultCode"] = o.ResultCode + } + if true { + toSerialize["status"] = o.Status + } + return json.Marshal(toSerialize) +} + +type NullableCreateAccountResponse struct { + value *CreateAccountResponse + isSet bool +} + +func (v NullableCreateAccountResponse) Get() *CreateAccountResponse { + return v.value +} + +func (v *NullableCreateAccountResponse) Set(val *CreateAccountResponse) { + v.value = val + v.isSet = true +} + +func (v NullableCreateAccountResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableCreateAccountResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCreateAccountResponse(val *CreateAccountResponse) *NullableCreateAccountResponse { + return &NullableCreateAccountResponse{value: val, isSet: true} +} + +func (v NullableCreateAccountResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCreateAccountResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_direct_debit_initiated_notification.go b/src/platformsnotificationevents/model_direct_debit_initiated_notification.go new file mode 100644 index 000000000..92c3378cc --- /dev/null +++ b/src/platformsnotificationevents/model_direct_debit_initiated_notification.go @@ -0,0 +1,303 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// DirectDebitInitiatedNotification struct for DirectDebitInitiatedNotification +type DirectDebitInitiatedNotification struct { + Content *DirectDebitInitiatedNotificationContent `json:"content,omitempty"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewDirectDebitInitiatedNotification instantiates a new DirectDebitInitiatedNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewDirectDebitInitiatedNotification(eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *DirectDebitInitiatedNotification { + this := DirectDebitInitiatedNotification{} + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewDirectDebitInitiatedNotificationWithDefaults instantiates a new DirectDebitInitiatedNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewDirectDebitInitiatedNotificationWithDefaults() *DirectDebitInitiatedNotification { + this := DirectDebitInitiatedNotification{} + return &this +} + +// GetContent returns the Content field value if set, zero value otherwise. +func (o *DirectDebitInitiatedNotification) GetContent() DirectDebitInitiatedNotificationContent { + if o == nil || o.Content == nil { + var ret DirectDebitInitiatedNotificationContent + return ret + } + return *o.Content +} + +// GetContentOk returns a tuple with the Content field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotification) GetContentOk() (*DirectDebitInitiatedNotificationContent, bool) { + if o == nil || o.Content == nil { + return nil, false + } + return o.Content, true +} + +// HasContent returns a boolean if a field has been set. +func (o *DirectDebitInitiatedNotification) HasContent() bool { + if o != nil && o.Content != nil { + return true + } + + return false +} + +// SetContent gets a reference to the given DirectDebitInitiatedNotificationContent and assigns it to the Content field. +func (o *DirectDebitInitiatedNotification) SetContent(v DirectDebitInitiatedNotificationContent) { + o.Content = &v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *DirectDebitInitiatedNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *DirectDebitInitiatedNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *DirectDebitInitiatedNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *DirectDebitInitiatedNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *DirectDebitInitiatedNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *DirectDebitInitiatedNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *DirectDebitInitiatedNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *DirectDebitInitiatedNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *DirectDebitInitiatedNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *DirectDebitInitiatedNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *DirectDebitInitiatedNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *DirectDebitInitiatedNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *DirectDebitInitiatedNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o DirectDebitInitiatedNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Content != nil { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableDirectDebitInitiatedNotification struct { + value *DirectDebitInitiatedNotification + isSet bool +} + +func (v NullableDirectDebitInitiatedNotification) Get() *DirectDebitInitiatedNotification { + return v.value +} + +func (v *NullableDirectDebitInitiatedNotification) Set(val *DirectDebitInitiatedNotification) { + v.value = val + v.isSet = true +} + +func (v NullableDirectDebitInitiatedNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableDirectDebitInitiatedNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableDirectDebitInitiatedNotification(val *DirectDebitInitiatedNotification) *NullableDirectDebitInitiatedNotification { + return &NullableDirectDebitInitiatedNotification{value: val, isSet: true} +} + +func (v NullableDirectDebitInitiatedNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableDirectDebitInitiatedNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_direct_debit_initiated_notification_content.go b/src/platformsnotificationevents/model_direct_debit_initiated_notification_content.go new file mode 100644 index 000000000..c9aca9b29 --- /dev/null +++ b/src/platformsnotificationevents/model_direct_debit_initiated_notification_content.go @@ -0,0 +1,241 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// DirectDebitInitiatedNotificationContent struct for DirectDebitInitiatedNotificationContent +type DirectDebitInitiatedNotificationContent struct { + // The code of the account. + AccountCode string `json:"accountCode"` + Amount Amount `json:"amount"` + DebitInitiationDate *LocalDate `json:"debitInitiationDate,omitempty"` + // The code of the merchant account. + MerchantAccountCode string `json:"merchantAccountCode"` + Status *OperationStatus `json:"status,omitempty"` +} + +// NewDirectDebitInitiatedNotificationContent instantiates a new DirectDebitInitiatedNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewDirectDebitInitiatedNotificationContent(accountCode string, amount Amount, merchantAccountCode string, ) *DirectDebitInitiatedNotificationContent { + this := DirectDebitInitiatedNotificationContent{} + this.AccountCode = accountCode + this.Amount = amount + this.MerchantAccountCode = merchantAccountCode + return &this +} + +// NewDirectDebitInitiatedNotificationContentWithDefaults instantiates a new DirectDebitInitiatedNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewDirectDebitInitiatedNotificationContentWithDefaults() *DirectDebitInitiatedNotificationContent { + this := DirectDebitInitiatedNotificationContent{} + return &this +} + +// GetAccountCode returns the AccountCode field value +func (o *DirectDebitInitiatedNotificationContent) GetAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountCode +} + +// GetAccountCodeOk returns a tuple with the AccountCode field value +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotificationContent) GetAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountCode, true +} + +// SetAccountCode sets field value +func (o *DirectDebitInitiatedNotificationContent) SetAccountCode(v string) { + o.AccountCode = v +} + +// GetAmount returns the Amount field value +func (o *DirectDebitInitiatedNotificationContent) GetAmount() Amount { + if o == nil { + var ret Amount + return ret + } + + return o.Amount +} + +// GetAmountOk returns a tuple with the Amount field value +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotificationContent) GetAmountOk() (*Amount, bool) { + if o == nil { + return nil, false + } + return &o.Amount, true +} + +// SetAmount sets field value +func (o *DirectDebitInitiatedNotificationContent) SetAmount(v Amount) { + o.Amount = v +} + +// GetDebitInitiationDate returns the DebitInitiationDate field value if set, zero value otherwise. +func (o *DirectDebitInitiatedNotificationContent) GetDebitInitiationDate() LocalDate { + if o == nil || o.DebitInitiationDate == nil { + var ret LocalDate + return ret + } + return *o.DebitInitiationDate +} + +// GetDebitInitiationDateOk returns a tuple with the DebitInitiationDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotificationContent) GetDebitInitiationDateOk() (*LocalDate, bool) { + if o == nil || o.DebitInitiationDate == nil { + return nil, false + } + return o.DebitInitiationDate, true +} + +// HasDebitInitiationDate returns a boolean if a field has been set. +func (o *DirectDebitInitiatedNotificationContent) HasDebitInitiationDate() bool { + if o != nil && o.DebitInitiationDate != nil { + return true + } + + return false +} + +// SetDebitInitiationDate gets a reference to the given LocalDate and assigns it to the DebitInitiationDate field. +func (o *DirectDebitInitiatedNotificationContent) SetDebitInitiationDate(v LocalDate) { + o.DebitInitiationDate = &v +} + +// GetMerchantAccountCode returns the MerchantAccountCode field value +func (o *DirectDebitInitiatedNotificationContent) GetMerchantAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.MerchantAccountCode +} + +// GetMerchantAccountCodeOk returns a tuple with the MerchantAccountCode field value +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotificationContent) GetMerchantAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.MerchantAccountCode, true +} + +// SetMerchantAccountCode sets field value +func (o *DirectDebitInitiatedNotificationContent) SetMerchantAccountCode(v string) { + o.MerchantAccountCode = v +} + +// GetStatus returns the Status field value if set, zero value otherwise. +func (o *DirectDebitInitiatedNotificationContent) GetStatus() OperationStatus { + if o == nil || o.Status == nil { + var ret OperationStatus + return ret + } + return *o.Status +} + +// GetStatusOk returns a tuple with the Status field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *DirectDebitInitiatedNotificationContent) GetStatusOk() (*OperationStatus, bool) { + if o == nil || o.Status == nil { + return nil, false + } + return o.Status, true +} + +// HasStatus returns a boolean if a field has been set. +func (o *DirectDebitInitiatedNotificationContent) HasStatus() bool { + if o != nil && o.Status != nil { + return true + } + + return false +} + +// SetStatus gets a reference to the given OperationStatus and assigns it to the Status field. +func (o *DirectDebitInitiatedNotificationContent) SetStatus(v OperationStatus) { + o.Status = &v +} + +func (o DirectDebitInitiatedNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["accountCode"] = o.AccountCode + } + if true { + toSerialize["amount"] = o.Amount + } + if o.DebitInitiationDate != nil { + toSerialize["debitInitiationDate"] = o.DebitInitiationDate + } + if true { + toSerialize["merchantAccountCode"] = o.MerchantAccountCode + } + if o.Status != nil { + toSerialize["status"] = o.Status + } + return json.Marshal(toSerialize) +} + +type NullableDirectDebitInitiatedNotificationContent struct { + value *DirectDebitInitiatedNotificationContent + isSet bool +} + +func (v NullableDirectDebitInitiatedNotificationContent) Get() *DirectDebitInitiatedNotificationContent { + return v.value +} + +func (v *NullableDirectDebitInitiatedNotificationContent) Set(val *DirectDebitInitiatedNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableDirectDebitInitiatedNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableDirectDebitInitiatedNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableDirectDebitInitiatedNotificationContent(val *DirectDebitInitiatedNotificationContent) *NullableDirectDebitInitiatedNotificationContent { + return &NullableDirectDebitInitiatedNotificationContent{value: val, isSet: true} +} + +func (v NullableDirectDebitInitiatedNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableDirectDebitInitiatedNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_error_field_type.go b/src/platformsnotificationevents/model_error_field_type.go new file mode 100644 index 000000000..61cc81796 --- /dev/null +++ b/src/platformsnotificationevents/model_error_field_type.go @@ -0,0 +1,190 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// ErrorFieldType struct for 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"` +} + +// NewErrorFieldType instantiates a new ErrorFieldType object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewErrorFieldType() *ErrorFieldType { + this := ErrorFieldType{} + return &this +} + +// NewErrorFieldTypeWithDefaults instantiates a new ErrorFieldType object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewErrorFieldTypeWithDefaults() *ErrorFieldType { + this := ErrorFieldType{} + return &this +} + +// GetErrorCode returns the ErrorCode field value if set, zero value otherwise. +func (o *ErrorFieldType) GetErrorCode() int32 { + if o == nil || o.ErrorCode == nil { + var ret int32 + return ret + } + return *o.ErrorCode +} + +// GetErrorCodeOk returns a tuple with the ErrorCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ErrorFieldType) GetErrorCodeOk() (*int32, bool) { + if o == nil || o.ErrorCode == nil { + return nil, false + } + return o.ErrorCode, true +} + +// HasErrorCode returns a boolean if a field has been set. +func (o *ErrorFieldType) HasErrorCode() bool { + if o != nil && o.ErrorCode != nil { + return true + } + + return false +} + +// SetErrorCode gets a reference to the given int32 and assigns it to the ErrorCode field. +func (o *ErrorFieldType) SetErrorCode(v int32) { + o.ErrorCode = &v +} + +// GetErrorDescription returns the ErrorDescription field value if set, zero value otherwise. +func (o *ErrorFieldType) GetErrorDescription() string { + if o == nil || o.ErrorDescription == nil { + var ret string + return ret + } + return *o.ErrorDescription +} + +// GetErrorDescriptionOk returns a tuple with the ErrorDescription field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ErrorFieldType) GetErrorDescriptionOk() (*string, bool) { + if o == nil || o.ErrorDescription == nil { + return nil, false + } + return o.ErrorDescription, true +} + +// HasErrorDescription returns a boolean if a field has been set. +func (o *ErrorFieldType) HasErrorDescription() bool { + if o != nil && o.ErrorDescription != nil { + return true + } + + return false +} + +// SetErrorDescription gets a reference to the given string and assigns it to the ErrorDescription field. +func (o *ErrorFieldType) SetErrorDescription(v string) { + o.ErrorDescription = &v +} + +// GetFieldType returns the FieldType field value if set, zero value otherwise. +func (o *ErrorFieldType) GetFieldType() FieldType { + if o == nil || o.FieldType == nil { + var ret FieldType + return ret + } + return *o.FieldType +} + +// GetFieldTypeOk returns a tuple with the FieldType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ErrorFieldType) GetFieldTypeOk() (*FieldType, bool) { + if o == nil || o.FieldType == nil { + return nil, false + } + return o.FieldType, true +} + +// HasFieldType returns a boolean if a field has been set. +func (o *ErrorFieldType) HasFieldType() bool { + if o != nil && o.FieldType != nil { + return true + } + + return false +} + +// SetFieldType gets a reference to the given FieldType and assigns it to the FieldType field. +func (o *ErrorFieldType) SetFieldType(v FieldType) { + o.FieldType = &v +} + +func (o ErrorFieldType) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.ErrorCode != nil { + toSerialize["errorCode"] = o.ErrorCode + } + if o.ErrorDescription != nil { + toSerialize["errorDescription"] = o.ErrorDescription + } + if o.FieldType != nil { + toSerialize["fieldType"] = o.FieldType + } + return json.Marshal(toSerialize) +} + +type NullableErrorFieldType struct { + value *ErrorFieldType + isSet bool +} + +func (v NullableErrorFieldType) Get() *ErrorFieldType { + return v.value +} + +func (v *NullableErrorFieldType) Set(val *ErrorFieldType) { + v.value = val + v.isSet = true +} + +func (v NullableErrorFieldType) IsSet() bool { + return v.isSet +} + +func (v *NullableErrorFieldType) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableErrorFieldType(val *ErrorFieldType) *NullableErrorFieldType { + return &NullableErrorFieldType{value: val, isSet: true} +} + +func (v NullableErrorFieldType) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableErrorFieldType) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_field_type.go b/src/platformsnotificationevents/model_field_type.go new file mode 100644 index 000000000..43e774df4 --- /dev/null +++ b/src/platformsnotificationevents/model_field_type.go @@ -0,0 +1,191 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// FieldType struct for 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"` +} + +// NewFieldType instantiates a new FieldType object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewFieldType() *FieldType { + this := FieldType{} + return &this +} + +// NewFieldTypeWithDefaults instantiates a new FieldType object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewFieldTypeWithDefaults() *FieldType { + this := FieldType{} + return &this +} + +// GetField returns the Field field value if set, zero value otherwise. +func (o *FieldType) GetField() string { + if o == nil || o.Field == nil { + var ret string + return ret + } + return *o.Field +} + +// GetFieldOk returns a tuple with the Field field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FieldType) GetFieldOk() (*string, bool) { + if o == nil || o.Field == nil { + return nil, false + } + return o.Field, true +} + +// HasField returns a boolean if a field has been set. +func (o *FieldType) HasField() bool { + if o != nil && o.Field != nil { + return true + } + + return false +} + +// SetField gets a reference to the given string and assigns it to the Field field. +func (o *FieldType) SetField(v string) { + o.Field = &v +} + +// GetFieldName returns the FieldName field value if set, zero value otherwise. +func (o *FieldType) GetFieldName() string { + if o == nil || o.FieldName == nil { + var ret string + return ret + } + return *o.FieldName +} + +// GetFieldNameOk returns a tuple with the FieldName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FieldType) GetFieldNameOk() (*string, bool) { + if o == nil || o.FieldName == nil { + return nil, false + } + return o.FieldName, true +} + +// HasFieldName returns a boolean if a field has been set. +func (o *FieldType) HasFieldName() bool { + if o != nil && o.FieldName != nil { + return true + } + + return false +} + +// SetFieldName gets a reference to the given string and assigns it to the FieldName field. +func (o *FieldType) SetFieldName(v string) { + o.FieldName = &v +} + +// GetShareholderCode returns the ShareholderCode field value if set, zero value otherwise. +func (o *FieldType) GetShareholderCode() string { + if o == nil || o.ShareholderCode == nil { + var ret string + return ret + } + return *o.ShareholderCode +} + +// GetShareholderCodeOk returns a tuple with the ShareholderCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *FieldType) GetShareholderCodeOk() (*string, bool) { + if o == nil || o.ShareholderCode == nil { + return nil, false + } + return o.ShareholderCode, true +} + +// HasShareholderCode returns a boolean if a field has been set. +func (o *FieldType) HasShareholderCode() bool { + if o != nil && o.ShareholderCode != nil { + return true + } + + return false +} + +// SetShareholderCode gets a reference to the given string and assigns it to the ShareholderCode field. +func (o *FieldType) SetShareholderCode(v string) { + o.ShareholderCode = &v +} + +func (o FieldType) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Field != nil { + toSerialize["field"] = o.Field + } + if o.FieldName != nil { + toSerialize["fieldName"] = o.FieldName + } + if o.ShareholderCode != nil { + toSerialize["shareholderCode"] = o.ShareholderCode + } + return json.Marshal(toSerialize) +} + +type NullableFieldType struct { + value *FieldType + isSet bool +} + +func (v NullableFieldType) Get() *FieldType { + return v.value +} + +func (v *NullableFieldType) Set(val *FieldType) { + v.value = val + v.isSet = true +} + +func (v NullableFieldType) IsSet() bool { + return v.isSet +} + +func (v *NullableFieldType) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableFieldType(val *FieldType) *NullableFieldType { + return &NullableFieldType{value: val, isSet: true} +} + +func (v NullableFieldType) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableFieldType) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_individual_details.go b/src/platformsnotificationevents/model_individual_details.go new file mode 100644 index 000000000..b25fabb44 --- /dev/null +++ b/src/platformsnotificationevents/model_individual_details.go @@ -0,0 +1,152 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// IndividualDetails struct for IndividualDetails +type IndividualDetails struct { + Name *ViasName `json:"name,omitempty"` + PersonalData *ViasPersonalData `json:"personalData,omitempty"` +} + +// NewIndividualDetails instantiates a new IndividualDetails object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewIndividualDetails() *IndividualDetails { + this := IndividualDetails{} + return &this +} + +// NewIndividualDetailsWithDefaults instantiates a new IndividualDetails object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewIndividualDetailsWithDefaults() *IndividualDetails { + this := IndividualDetails{} + return &this +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *IndividualDetails) GetName() ViasName { + if o == nil || o.Name == nil { + var ret ViasName + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *IndividualDetails) GetNameOk() (*ViasName, bool) { + if o == nil || o.Name == nil { + return nil, false + } + return o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *IndividualDetails) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given ViasName and assigns it to the Name field. +func (o *IndividualDetails) SetName(v ViasName) { + o.Name = &v +} + +// GetPersonalData returns the PersonalData field value if set, zero value otherwise. +func (o *IndividualDetails) GetPersonalData() ViasPersonalData { + if o == nil || o.PersonalData == nil { + var ret ViasPersonalData + return ret + } + return *o.PersonalData +} + +// GetPersonalDataOk returns a tuple with the PersonalData field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *IndividualDetails) GetPersonalDataOk() (*ViasPersonalData, bool) { + if o == nil || o.PersonalData == nil { + return nil, false + } + return o.PersonalData, true +} + +// HasPersonalData returns a boolean if a field has been set. +func (o *IndividualDetails) HasPersonalData() bool { + if o != nil && o.PersonalData != nil { + return true + } + + return false +} + +// SetPersonalData gets a reference to the given ViasPersonalData and assigns it to the PersonalData field. +func (o *IndividualDetails) SetPersonalData(v ViasPersonalData) { + o.PersonalData = &v +} + +func (o IndividualDetails) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Name != nil { + toSerialize["name"] = o.Name + } + if o.PersonalData != nil { + toSerialize["personalData"] = o.PersonalData + } + return json.Marshal(toSerialize) +} + +type NullableIndividualDetails struct { + value *IndividualDetails + isSet bool +} + +func (v NullableIndividualDetails) Get() *IndividualDetails { + return v.value +} + +func (v *NullableIndividualDetails) Set(val *IndividualDetails) { + v.value = val + v.isSet = true +} + +func (v NullableIndividualDetails) IsSet() bool { + return v.isSet +} + +func (v *NullableIndividualDetails) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableIndividualDetails(val *IndividualDetails) *NullableIndividualDetails { + return &NullableIndividualDetails{value: val, isSet: true} +} + +func (v NullableIndividualDetails) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableIndividualDetails) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_kyc_check_result.go b/src/platformsnotificationevents/model_kyc_check_result.go new file mode 100644 index 000000000..d6f6ca681 --- /dev/null +++ b/src/platformsnotificationevents/model_kyc_check_result.go @@ -0,0 +1,117 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// KYCCheckResult struct for KYCCheckResult +type KYCCheckResult struct { + // A list of the checks and their statuses. + Checks *[]KYCCheckStatusData `json:"checks,omitempty"` +} + +// NewKYCCheckResult instantiates a new KYCCheckResult object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewKYCCheckResult() *KYCCheckResult { + this := KYCCheckResult{} + return &this +} + +// NewKYCCheckResultWithDefaults instantiates a new KYCCheckResult object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewKYCCheckResultWithDefaults() *KYCCheckResult { + this := KYCCheckResult{} + return &this +} + +// GetChecks returns the Checks field value if set, zero value otherwise. +func (o *KYCCheckResult) GetChecks() []KYCCheckStatusData { + if o == nil || o.Checks == nil { + var ret []KYCCheckStatusData + return ret + } + return *o.Checks +} + +// GetChecksOk returns a tuple with the Checks field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCCheckResult) GetChecksOk() (*[]KYCCheckStatusData, bool) { + if o == nil || o.Checks == nil { + return nil, false + } + return o.Checks, true +} + +// HasChecks returns a boolean if a field has been set. +func (o *KYCCheckResult) HasChecks() bool { + if o != nil && o.Checks != nil { + return true + } + + return false +} + +// SetChecks gets a reference to the given []KYCCheckStatusData and assigns it to the Checks field. +func (o *KYCCheckResult) SetChecks(v []KYCCheckStatusData) { + o.Checks = &v +} + +func (o KYCCheckResult) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Checks != nil { + toSerialize["checks"] = o.Checks + } + return json.Marshal(toSerialize) +} + +type NullableKYCCheckResult struct { + value *KYCCheckResult + isSet bool +} + +func (v NullableKYCCheckResult) Get() *KYCCheckResult { + return v.value +} + +func (v *NullableKYCCheckResult) Set(val *KYCCheckResult) { + v.value = val + v.isSet = true +} + +func (v NullableKYCCheckResult) IsSet() bool { + return v.isSet +} + +func (v *NullableKYCCheckResult) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableKYCCheckResult(val *KYCCheckResult) *NullableKYCCheckResult { + return &NullableKYCCheckResult{value: val, isSet: true} +} + +func (v NullableKYCCheckResult) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableKYCCheckResult) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_kyc_check_status_data.go b/src/platformsnotificationevents/model_kyc_check_status_data.go new file mode 100644 index 000000000..4e3eae501 --- /dev/null +++ b/src/platformsnotificationevents/model_kyc_check_status_data.go @@ -0,0 +1,213 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// KYCCheckStatusData struct for KYCCheckStatusData +type KYCCheckStatusData struct { + // A list of the fields required for execution of the check. + RequiredFields *[]string `json:"requiredFields,omitempty"` + // The status of the check. >Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`. + Status string `json:"status"` + Summary *KYCCheckSummary `json:"summary,omitempty"` + // The type of check. >Permitted Values: `COMPANY_VERIFICATION`, `IDENTITY_VERIFICATION`, `PASSPORT_VERIFICATION`, `BANK_ACCOUNT_VERIFICATION`, `NONPROFIT_VERIFICATION`, `CARD_VERIFICATION`. + Type string `json:"type"` +} + +// NewKYCCheckStatusData instantiates a new KYCCheckStatusData object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewKYCCheckStatusData(status string, type_ string, ) *KYCCheckStatusData { + this := KYCCheckStatusData{} + this.Status = status + this.Type = type_ + return &this +} + +// NewKYCCheckStatusDataWithDefaults instantiates a new KYCCheckStatusData object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewKYCCheckStatusDataWithDefaults() *KYCCheckStatusData { + this := KYCCheckStatusData{} + return &this +} + +// GetRequiredFields returns the RequiredFields field value if set, zero value otherwise. +func (o *KYCCheckStatusData) GetRequiredFields() []string { + if o == nil || o.RequiredFields == nil { + var ret []string + return ret + } + return *o.RequiredFields +} + +// GetRequiredFieldsOk returns a tuple with the RequiredFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCCheckStatusData) GetRequiredFieldsOk() (*[]string, bool) { + if o == nil || o.RequiredFields == nil { + return nil, false + } + return o.RequiredFields, true +} + +// HasRequiredFields returns a boolean if a field has been set. +func (o *KYCCheckStatusData) HasRequiredFields() bool { + if o != nil && o.RequiredFields != nil { + return true + } + + return false +} + +// SetRequiredFields gets a reference to the given []string and assigns it to the RequiredFields field. +func (o *KYCCheckStatusData) SetRequiredFields(v []string) { + o.RequiredFields = &v +} + +// GetStatus returns the Status field value +func (o *KYCCheckStatusData) GetStatus() string { + if o == nil { + var ret string + return ret + } + + return o.Status +} + +// GetStatusOk returns a tuple with the Status field value +// and a boolean to check if the value has been set. +func (o *KYCCheckStatusData) GetStatusOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Status, true +} + +// SetStatus sets field value +func (o *KYCCheckStatusData) SetStatus(v string) { + o.Status = v +} + +// GetSummary returns the Summary field value if set, zero value otherwise. +func (o *KYCCheckStatusData) GetSummary() KYCCheckSummary { + if o == nil || o.Summary == nil { + var ret KYCCheckSummary + return ret + } + return *o.Summary +} + +// GetSummaryOk returns a tuple with the Summary field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCCheckStatusData) GetSummaryOk() (*KYCCheckSummary, bool) { + if o == nil || o.Summary == nil { + return nil, false + } + return o.Summary, true +} + +// HasSummary returns a boolean if a field has been set. +func (o *KYCCheckStatusData) HasSummary() bool { + if o != nil && o.Summary != nil { + return true + } + + return false +} + +// SetSummary gets a reference to the given KYCCheckSummary and assigns it to the Summary field. +func (o *KYCCheckStatusData) SetSummary(v KYCCheckSummary) { + o.Summary = &v +} + +// GetType returns the Type field value +func (o *KYCCheckStatusData) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// GetTypeOk returns a tuple with the Type field value +// and a boolean to check if the value has been set. +func (o *KYCCheckStatusData) GetTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Type, true +} + +// SetType sets field value +func (o *KYCCheckStatusData) SetType(v string) { + o.Type = v +} + +func (o KYCCheckStatusData) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.RequiredFields != nil { + toSerialize["requiredFields"] = o.RequiredFields + } + if true { + toSerialize["status"] = o.Status + } + if o.Summary != nil { + toSerialize["summary"] = o.Summary + } + if true { + toSerialize["type"] = o.Type + } + return json.Marshal(toSerialize) +} + +type NullableKYCCheckStatusData struct { + value *KYCCheckStatusData + isSet bool +} + +func (v NullableKYCCheckStatusData) Get() *KYCCheckStatusData { + return v.value +} + +func (v *NullableKYCCheckStatusData) Set(val *KYCCheckStatusData) { + v.value = val + v.isSet = true +} + +func (v NullableKYCCheckStatusData) IsSet() bool { + return v.isSet +} + +func (v *NullableKYCCheckStatusData) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableKYCCheckStatusData(val *KYCCheckStatusData) *NullableKYCCheckStatusData { + return &NullableKYCCheckStatusData{value: val, isSet: true} +} + +func (v NullableKYCCheckStatusData) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableKYCCheckStatusData) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_kyc_check_summary.go b/src/platformsnotificationevents/model_kyc_check_summary.go new file mode 100644 index 000000000..a4d3be6e6 --- /dev/null +++ b/src/platformsnotificationevents/model_kyc_check_summary.go @@ -0,0 +1,154 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// KYCCheckSummary struct for KYCCheckSummary +type KYCCheckSummary struct { + // The code of the check. + KycCheckCode *int32 `json:"kycCheckCode,omitempty"` + // A description of the check. + KycCheckDescription *string `json:"kycCheckDescription,omitempty"` +} + +// NewKYCCheckSummary instantiates a new KYCCheckSummary object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewKYCCheckSummary() *KYCCheckSummary { + this := KYCCheckSummary{} + return &this +} + +// NewKYCCheckSummaryWithDefaults instantiates a new KYCCheckSummary object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewKYCCheckSummaryWithDefaults() *KYCCheckSummary { + this := KYCCheckSummary{} + return &this +} + +// GetKycCheckCode returns the KycCheckCode field value if set, zero value otherwise. +func (o *KYCCheckSummary) GetKycCheckCode() int32 { + if o == nil || o.KycCheckCode == nil { + var ret int32 + return ret + } + return *o.KycCheckCode +} + +// GetKycCheckCodeOk returns a tuple with the KycCheckCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCCheckSummary) GetKycCheckCodeOk() (*int32, bool) { + if o == nil || o.KycCheckCode == nil { + return nil, false + } + return o.KycCheckCode, true +} + +// HasKycCheckCode returns a boolean if a field has been set. +func (o *KYCCheckSummary) HasKycCheckCode() bool { + if o != nil && o.KycCheckCode != nil { + return true + } + + return false +} + +// SetKycCheckCode gets a reference to the given int32 and assigns it to the KycCheckCode field. +func (o *KYCCheckSummary) SetKycCheckCode(v int32) { + o.KycCheckCode = &v +} + +// GetKycCheckDescription returns the KycCheckDescription field value if set, zero value otherwise. +func (o *KYCCheckSummary) GetKycCheckDescription() string { + if o == nil || o.KycCheckDescription == nil { + var ret string + return ret + } + return *o.KycCheckDescription +} + +// GetKycCheckDescriptionOk returns a tuple with the KycCheckDescription field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCCheckSummary) GetKycCheckDescriptionOk() (*string, bool) { + if o == nil || o.KycCheckDescription == nil { + return nil, false + } + return o.KycCheckDescription, true +} + +// HasKycCheckDescription returns a boolean if a field has been set. +func (o *KYCCheckSummary) HasKycCheckDescription() bool { + if o != nil && o.KycCheckDescription != nil { + return true + } + + return false +} + +// SetKycCheckDescription gets a reference to the given string and assigns it to the KycCheckDescription field. +func (o *KYCCheckSummary) SetKycCheckDescription(v string) { + o.KycCheckDescription = &v +} + +func (o KYCCheckSummary) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.KycCheckCode != nil { + toSerialize["kycCheckCode"] = o.KycCheckCode + } + if o.KycCheckDescription != nil { + toSerialize["kycCheckDescription"] = o.KycCheckDescription + } + return json.Marshal(toSerialize) +} + +type NullableKYCCheckSummary struct { + value *KYCCheckSummary + isSet bool +} + +func (v NullableKYCCheckSummary) Get() *KYCCheckSummary { + return v.value +} + +func (v *NullableKYCCheckSummary) Set(val *KYCCheckSummary) { + v.value = val + v.isSet = true +} + +func (v NullableKYCCheckSummary) IsSet() bool { + return v.isSet +} + +func (v *NullableKYCCheckSummary) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableKYCCheckSummary(val *KYCCheckSummary) *NullableKYCCheckSummary { + return &NullableKYCCheckSummary{value: val, isSet: true} +} + +func (v NullableKYCCheckSummary) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableKYCCheckSummary) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_kyc_payout_method_check_result.go b/src/platformsnotificationevents/model_kyc_payout_method_check_result.go new file mode 100644 index 000000000..a30f6cc71 --- /dev/null +++ b/src/platformsnotificationevents/model_kyc_payout_method_check_result.go @@ -0,0 +1,154 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// KYCPayoutMethodCheckResult struct for KYCPayoutMethodCheckResult +type KYCPayoutMethodCheckResult struct { + // A list of the checks and their statuses. + Checks *[]KYCCheckStatusData `json:"checks,omitempty"` + // The unique ID of the payoput method to which the check applies. + PayoutMethodCode *string `json:"payoutMethodCode,omitempty"` +} + +// NewKYCPayoutMethodCheckResult instantiates a new KYCPayoutMethodCheckResult object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewKYCPayoutMethodCheckResult() *KYCPayoutMethodCheckResult { + this := KYCPayoutMethodCheckResult{} + return &this +} + +// NewKYCPayoutMethodCheckResultWithDefaults instantiates a new KYCPayoutMethodCheckResult object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewKYCPayoutMethodCheckResultWithDefaults() *KYCPayoutMethodCheckResult { + this := KYCPayoutMethodCheckResult{} + return &this +} + +// GetChecks returns the Checks field value if set, zero value otherwise. +func (o *KYCPayoutMethodCheckResult) GetChecks() []KYCCheckStatusData { + if o == nil || o.Checks == nil { + var ret []KYCCheckStatusData + return ret + } + return *o.Checks +} + +// GetChecksOk returns a tuple with the Checks field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCPayoutMethodCheckResult) GetChecksOk() (*[]KYCCheckStatusData, bool) { + if o == nil || o.Checks == nil { + return nil, false + } + return o.Checks, true +} + +// HasChecks returns a boolean if a field has been set. +func (o *KYCPayoutMethodCheckResult) HasChecks() bool { + if o != nil && o.Checks != nil { + return true + } + + return false +} + +// SetChecks gets a reference to the given []KYCCheckStatusData and assigns it to the Checks field. +func (o *KYCPayoutMethodCheckResult) SetChecks(v []KYCCheckStatusData) { + o.Checks = &v +} + +// GetPayoutMethodCode returns the PayoutMethodCode field value if set, zero value otherwise. +func (o *KYCPayoutMethodCheckResult) GetPayoutMethodCode() string { + if o == nil || o.PayoutMethodCode == nil { + var ret string + return ret + } + return *o.PayoutMethodCode +} + +// GetPayoutMethodCodeOk returns a tuple with the PayoutMethodCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCPayoutMethodCheckResult) GetPayoutMethodCodeOk() (*string, bool) { + if o == nil || o.PayoutMethodCode == nil { + return nil, false + } + return o.PayoutMethodCode, true +} + +// HasPayoutMethodCode returns a boolean if a field has been set. +func (o *KYCPayoutMethodCheckResult) HasPayoutMethodCode() bool { + if o != nil && o.PayoutMethodCode != nil { + return true + } + + return false +} + +// SetPayoutMethodCode gets a reference to the given string and assigns it to the PayoutMethodCode field. +func (o *KYCPayoutMethodCheckResult) SetPayoutMethodCode(v string) { + o.PayoutMethodCode = &v +} + +func (o KYCPayoutMethodCheckResult) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Checks != nil { + toSerialize["checks"] = o.Checks + } + if o.PayoutMethodCode != nil { + toSerialize["payoutMethodCode"] = o.PayoutMethodCode + } + return json.Marshal(toSerialize) +} + +type NullableKYCPayoutMethodCheckResult struct { + value *KYCPayoutMethodCheckResult + isSet bool +} + +func (v NullableKYCPayoutMethodCheckResult) Get() *KYCPayoutMethodCheckResult { + return v.value +} + +func (v *NullableKYCPayoutMethodCheckResult) Set(val *KYCPayoutMethodCheckResult) { + v.value = val + v.isSet = true +} + +func (v NullableKYCPayoutMethodCheckResult) IsSet() bool { + return v.isSet +} + +func (v *NullableKYCPayoutMethodCheckResult) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableKYCPayoutMethodCheckResult(val *KYCPayoutMethodCheckResult) *NullableKYCPayoutMethodCheckResult { + return &NullableKYCPayoutMethodCheckResult{value: val, isSet: true} +} + +func (v NullableKYCPayoutMethodCheckResult) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableKYCPayoutMethodCheckResult) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_kyc_shareholder_check_result.go b/src/platformsnotificationevents/model_kyc_shareholder_check_result.go new file mode 100644 index 000000000..00554c488 --- /dev/null +++ b/src/platformsnotificationevents/model_kyc_shareholder_check_result.go @@ -0,0 +1,154 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// KYCShareholderCheckResult struct for KYCShareholderCheckResult +type KYCShareholderCheckResult struct { + // A list of the checks and their statuses. + Checks *[]KYCCheckStatusData `json:"checks,omitempty"` + // The code of the shareholder to which the check applies. + ShareholderCode *string `json:"shareholderCode,omitempty"` +} + +// NewKYCShareholderCheckResult instantiates a new KYCShareholderCheckResult object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewKYCShareholderCheckResult() *KYCShareholderCheckResult { + this := KYCShareholderCheckResult{} + return &this +} + +// NewKYCShareholderCheckResultWithDefaults instantiates a new KYCShareholderCheckResult object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewKYCShareholderCheckResultWithDefaults() *KYCShareholderCheckResult { + this := KYCShareholderCheckResult{} + return &this +} + +// GetChecks returns the Checks field value if set, zero value otherwise. +func (o *KYCShareholderCheckResult) GetChecks() []KYCCheckStatusData { + if o == nil || o.Checks == nil { + var ret []KYCCheckStatusData + return ret + } + return *o.Checks +} + +// GetChecksOk returns a tuple with the Checks field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCShareholderCheckResult) GetChecksOk() (*[]KYCCheckStatusData, bool) { + if o == nil || o.Checks == nil { + return nil, false + } + return o.Checks, true +} + +// HasChecks returns a boolean if a field has been set. +func (o *KYCShareholderCheckResult) HasChecks() bool { + if o != nil && o.Checks != nil { + return true + } + + return false +} + +// SetChecks gets a reference to the given []KYCCheckStatusData and assigns it to the Checks field. +func (o *KYCShareholderCheckResult) SetChecks(v []KYCCheckStatusData) { + o.Checks = &v +} + +// GetShareholderCode returns the ShareholderCode field value if set, zero value otherwise. +func (o *KYCShareholderCheckResult) GetShareholderCode() string { + if o == nil || o.ShareholderCode == nil { + var ret string + return ret + } + return *o.ShareholderCode +} + +// GetShareholderCodeOk returns a tuple with the ShareholderCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCShareholderCheckResult) GetShareholderCodeOk() (*string, bool) { + if o == nil || o.ShareholderCode == nil { + return nil, false + } + return o.ShareholderCode, true +} + +// HasShareholderCode returns a boolean if a field has been set. +func (o *KYCShareholderCheckResult) HasShareholderCode() bool { + if o != nil && o.ShareholderCode != nil { + return true + } + + return false +} + +// SetShareholderCode gets a reference to the given string and assigns it to the ShareholderCode field. +func (o *KYCShareholderCheckResult) SetShareholderCode(v string) { + o.ShareholderCode = &v +} + +func (o KYCShareholderCheckResult) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Checks != nil { + toSerialize["checks"] = o.Checks + } + if o.ShareholderCode != nil { + toSerialize["shareholderCode"] = o.ShareholderCode + } + return json.Marshal(toSerialize) +} + +type NullableKYCShareholderCheckResult struct { + value *KYCShareholderCheckResult + isSet bool +} + +func (v NullableKYCShareholderCheckResult) Get() *KYCShareholderCheckResult { + return v.value +} + +func (v *NullableKYCShareholderCheckResult) Set(val *KYCShareholderCheckResult) { + v.value = val + v.isSet = true +} + +func (v NullableKYCShareholderCheckResult) IsSet() bool { + return v.isSet +} + +func (v *NullableKYCShareholderCheckResult) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableKYCShareholderCheckResult(val *KYCShareholderCheckResult) *NullableKYCShareholderCheckResult { + return &NullableKYCShareholderCheckResult{value: val, isSet: true} +} + +func (v NullableKYCShareholderCheckResult) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableKYCShareholderCheckResult) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_kyc_verification_result.go b/src/platformsnotificationevents/model_kyc_verification_result.go new file mode 100644 index 000000000..b18e3ba0b --- /dev/null +++ b/src/platformsnotificationevents/model_kyc_verification_result.go @@ -0,0 +1,190 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// KYCVerificationResult struct for KYCVerificationResult +type KYCVerificationResult struct { + AccountHolder *KYCCheckResult `json:"accountHolder,omitempty"` + // The result(s) of the checks on the payout method(s). + PayoutMethods *[]KYCPayoutMethodCheckResult `json:"payoutMethods,omitempty"` + // The result(s) of the checks on the shareholder(s). + Shareholders *[]KYCShareholderCheckResult `json:"shareholders,omitempty"` +} + +// NewKYCVerificationResult instantiates a new KYCVerificationResult object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewKYCVerificationResult() *KYCVerificationResult { + this := KYCVerificationResult{} + return &this +} + +// NewKYCVerificationResultWithDefaults instantiates a new KYCVerificationResult object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewKYCVerificationResultWithDefaults() *KYCVerificationResult { + this := KYCVerificationResult{} + return &this +} + +// GetAccountHolder returns the AccountHolder field value if set, zero value otherwise. +func (o *KYCVerificationResult) GetAccountHolder() KYCCheckResult { + if o == nil || o.AccountHolder == nil { + var ret KYCCheckResult + return ret + } + return *o.AccountHolder +} + +// GetAccountHolderOk returns a tuple with the AccountHolder field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCVerificationResult) GetAccountHolderOk() (*KYCCheckResult, bool) { + if o == nil || o.AccountHolder == nil { + return nil, false + } + return o.AccountHolder, true +} + +// HasAccountHolder returns a boolean if a field has been set. +func (o *KYCVerificationResult) HasAccountHolder() bool { + if o != nil && o.AccountHolder != nil { + return true + } + + return false +} + +// SetAccountHolder gets a reference to the given KYCCheckResult and assigns it to the AccountHolder field. +func (o *KYCVerificationResult) SetAccountHolder(v KYCCheckResult) { + o.AccountHolder = &v +} + +// GetPayoutMethods returns the PayoutMethods field value if set, zero value otherwise. +func (o *KYCVerificationResult) GetPayoutMethods() []KYCPayoutMethodCheckResult { + if o == nil || o.PayoutMethods == nil { + var ret []KYCPayoutMethodCheckResult + return ret + } + return *o.PayoutMethods +} + +// GetPayoutMethodsOk returns a tuple with the PayoutMethods field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCVerificationResult) GetPayoutMethodsOk() (*[]KYCPayoutMethodCheckResult, bool) { + if o == nil || o.PayoutMethods == nil { + return nil, false + } + return o.PayoutMethods, true +} + +// HasPayoutMethods returns a boolean if a field has been set. +func (o *KYCVerificationResult) HasPayoutMethods() bool { + if o != nil && o.PayoutMethods != nil { + return true + } + + return false +} + +// SetPayoutMethods gets a reference to the given []KYCPayoutMethodCheckResult and assigns it to the PayoutMethods field. +func (o *KYCVerificationResult) SetPayoutMethods(v []KYCPayoutMethodCheckResult) { + o.PayoutMethods = &v +} + +// GetShareholders returns the Shareholders field value if set, zero value otherwise. +func (o *KYCVerificationResult) GetShareholders() []KYCShareholderCheckResult { + if o == nil || o.Shareholders == nil { + var ret []KYCShareholderCheckResult + return ret + } + return *o.Shareholders +} + +// GetShareholdersOk returns a tuple with the Shareholders field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *KYCVerificationResult) GetShareholdersOk() (*[]KYCShareholderCheckResult, bool) { + if o == nil || o.Shareholders == nil { + return nil, false + } + return o.Shareholders, true +} + +// HasShareholders returns a boolean if a field has been set. +func (o *KYCVerificationResult) HasShareholders() bool { + if o != nil && o.Shareholders != nil { + return true + } + + return false +} + +// SetShareholders gets a reference to the given []KYCShareholderCheckResult and assigns it to the Shareholders field. +func (o *KYCVerificationResult) SetShareholders(v []KYCShareholderCheckResult) { + o.Shareholders = &v +} + +func (o KYCVerificationResult) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.AccountHolder != nil { + toSerialize["accountHolder"] = o.AccountHolder + } + if o.PayoutMethods != nil { + toSerialize["payoutMethods"] = o.PayoutMethods + } + if o.Shareholders != nil { + toSerialize["shareholders"] = o.Shareholders + } + return json.Marshal(toSerialize) +} + +type NullableKYCVerificationResult struct { + value *KYCVerificationResult + isSet bool +} + +func (v NullableKYCVerificationResult) Get() *KYCVerificationResult { + return v.value +} + +func (v *NullableKYCVerificationResult) Set(val *KYCVerificationResult) { + v.value = val + v.isSet = true +} + +func (v NullableKYCVerificationResult) IsSet() bool { + return v.isSet +} + +func (v *NullableKYCVerificationResult) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableKYCVerificationResult(val *KYCVerificationResult) *NullableKYCVerificationResult { + return &NullableKYCVerificationResult{value: val, isSet: true} +} + +func (v NullableKYCVerificationResult) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableKYCVerificationResult) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_local_date.go b/src/platformsnotificationevents/model_local_date.go new file mode 100644 index 000000000..521b131f3 --- /dev/null +++ b/src/platformsnotificationevents/model_local_date.go @@ -0,0 +1,152 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// LocalDate struct for LocalDate +type LocalDate struct { + Month *int32 `json:"month,omitempty"` + Year *int32 `json:"year,omitempty"` +} + +// NewLocalDate instantiates a new LocalDate object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewLocalDate() *LocalDate { + this := LocalDate{} + return &this +} + +// NewLocalDateWithDefaults instantiates a new LocalDate object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewLocalDateWithDefaults() *LocalDate { + this := LocalDate{} + return &this +} + +// GetMonth returns the Month field value if set, zero value otherwise. +func (o *LocalDate) GetMonth() int32 { + if o == nil || o.Month == nil { + var ret int32 + return ret + } + return *o.Month +} + +// GetMonthOk returns a tuple with the Month field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *LocalDate) GetMonthOk() (*int32, bool) { + if o == nil || o.Month == nil { + return nil, false + } + return o.Month, true +} + +// HasMonth returns a boolean if a field has been set. +func (o *LocalDate) HasMonth() bool { + if o != nil && o.Month != nil { + return true + } + + return false +} + +// SetMonth gets a reference to the given int32 and assigns it to the Month field. +func (o *LocalDate) SetMonth(v int32) { + o.Month = &v +} + +// GetYear returns the Year field value if set, zero value otherwise. +func (o *LocalDate) GetYear() int32 { + if o == nil || o.Year == nil { + var ret int32 + return ret + } + return *o.Year +} + +// GetYearOk returns a tuple with the Year field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *LocalDate) GetYearOk() (*int32, bool) { + if o == nil || o.Year == nil { + return nil, false + } + return o.Year, true +} + +// HasYear returns a boolean if a field has been set. +func (o *LocalDate) HasYear() bool { + if o != nil && o.Year != nil { + return true + } + + return false +} + +// SetYear gets a reference to the given int32 and assigns it to the Year field. +func (o *LocalDate) SetYear(v int32) { + o.Year = &v +} + +func (o LocalDate) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Month != nil { + toSerialize["month"] = o.Month + } + if o.Year != nil { + toSerialize["year"] = o.Year + } + return json.Marshal(toSerialize) +} + +type NullableLocalDate struct { + value *LocalDate + isSet bool +} + +func (v NullableLocalDate) Get() *LocalDate { + return v.value +} + +func (v *NullableLocalDate) Set(val *LocalDate) { + v.value = val + v.isSet = true +} + +func (v NullableLocalDate) IsSet() bool { + return v.isSet +} + +func (v *NullableLocalDate) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableLocalDate(val *LocalDate) *NullableLocalDate { + return &NullableLocalDate{value: val, isSet: true} +} + +func (v NullableLocalDate) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableLocalDate) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_message.go b/src/platformsnotificationevents/model_message.go new file mode 100644 index 000000000..5ca874d71 --- /dev/null +++ b/src/platformsnotificationevents/model_message.go @@ -0,0 +1,154 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// Message struct for Message +type Message struct { + // The message code. + Code *string `json:"code,omitempty"` + // The message text. + Text *string `json:"text,omitempty"` +} + +// NewMessage instantiates a new Message object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewMessage() *Message { + this := Message{} + return &this +} + +// NewMessageWithDefaults instantiates a new Message object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewMessageWithDefaults() *Message { + this := Message{} + return &this +} + +// GetCode returns the Code field value if set, zero value otherwise. +func (o *Message) GetCode() string { + if o == nil || o.Code == nil { + var ret string + return ret + } + return *o.Code +} + +// GetCodeOk returns a tuple with the Code field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Message) GetCodeOk() (*string, bool) { + if o == nil || o.Code == nil { + return nil, false + } + return o.Code, true +} + +// HasCode returns a boolean if a field has been set. +func (o *Message) HasCode() bool { + if o != nil && o.Code != nil { + return true + } + + return false +} + +// SetCode gets a reference to the given string and assigns it to the Code field. +func (o *Message) SetCode(v string) { + o.Code = &v +} + +// GetText returns the Text field value if set, zero value otherwise. +func (o *Message) GetText() string { + if o == nil || o.Text == nil { + var ret string + return ret + } + return *o.Text +} + +// GetTextOk returns a tuple with the Text field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Message) GetTextOk() (*string, bool) { + if o == nil || o.Text == nil { + return nil, false + } + return o.Text, true +} + +// HasText returns a boolean if a field has been set. +func (o *Message) HasText() bool { + if o != nil && o.Text != nil { + return true + } + + return false +} + +// SetText gets a reference to the given string and assigns it to the Text field. +func (o *Message) SetText(v string) { + o.Text = &v +} + +func (o Message) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Code != nil { + toSerialize["code"] = o.Code + } + if o.Text != nil { + toSerialize["text"] = o.Text + } + return json.Marshal(toSerialize) +} + +type NullableMessage struct { + value *Message + isSet bool +} + +func (v NullableMessage) Get() *Message { + return v.value +} + +func (v *NullableMessage) Set(val *Message) { + v.value = val + v.isSet = true +} + +func (v NullableMessage) IsSet() bool { + return v.isSet +} + +func (v *NullableMessage) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableMessage(val *Message) *NullableMessage { + return &NullableMessage{value: val, isSet: true} +} + +func (v NullableMessage) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableMessage) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_notification_error_container.go b/src/platformsnotificationevents/model_notification_error_container.go new file mode 100644 index 000000000..ca9632c5b --- /dev/null +++ b/src/platformsnotificationevents/model_notification_error_container.go @@ -0,0 +1,154 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// NotificationErrorContainer struct for NotificationErrorContainer +type NotificationErrorContainer struct { + // The Adyen code that is mapped to the error message. + ErrorCode *string `json:"errorCode,omitempty"` + // A short explanation of the issue. + Message *string `json:"message,omitempty"` +} + +// NewNotificationErrorContainer instantiates a new NotificationErrorContainer object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewNotificationErrorContainer() *NotificationErrorContainer { + this := NotificationErrorContainer{} + return &this +} + +// NewNotificationErrorContainerWithDefaults instantiates a new NotificationErrorContainer object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewNotificationErrorContainerWithDefaults() *NotificationErrorContainer { + this := NotificationErrorContainer{} + return &this +} + +// GetErrorCode returns the ErrorCode field value if set, zero value otherwise. +func (o *NotificationErrorContainer) GetErrorCode() string { + if o == nil || o.ErrorCode == nil { + var ret string + return ret + } + return *o.ErrorCode +} + +// GetErrorCodeOk returns a tuple with the ErrorCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *NotificationErrorContainer) GetErrorCodeOk() (*string, bool) { + if o == nil || o.ErrorCode == nil { + return nil, false + } + return o.ErrorCode, true +} + +// HasErrorCode returns a boolean if a field has been set. +func (o *NotificationErrorContainer) HasErrorCode() bool { + if o != nil && o.ErrorCode != nil { + return true + } + + return false +} + +// SetErrorCode gets a reference to the given string and assigns it to the ErrorCode field. +func (o *NotificationErrorContainer) SetErrorCode(v string) { + o.ErrorCode = &v +} + +// GetMessage returns the Message field value if set, zero value otherwise. +func (o *NotificationErrorContainer) GetMessage() string { + if o == nil || o.Message == nil { + var ret string + return ret + } + return *o.Message +} + +// GetMessageOk returns a tuple with the Message field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *NotificationErrorContainer) GetMessageOk() (*string, bool) { + if o == nil || o.Message == nil { + return nil, false + } + return o.Message, true +} + +// HasMessage returns a boolean if a field has been set. +func (o *NotificationErrorContainer) HasMessage() bool { + if o != nil && o.Message != nil { + return true + } + + return false +} + +// SetMessage gets a reference to the given string and assigns it to the Message field. +func (o *NotificationErrorContainer) SetMessage(v string) { + o.Message = &v +} + +func (o NotificationErrorContainer) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.ErrorCode != nil { + toSerialize["errorCode"] = o.ErrorCode + } + if o.Message != nil { + toSerialize["message"] = o.Message + } + return json.Marshal(toSerialize) +} + +type NullableNotificationErrorContainer struct { + value *NotificationErrorContainer + isSet bool +} + +func (v NullableNotificationErrorContainer) Get() *NotificationErrorContainer { + return v.value +} + +func (v *NullableNotificationErrorContainer) Set(val *NotificationErrorContainer) { + v.value = val + v.isSet = true +} + +func (v NullableNotificationErrorContainer) IsSet() bool { + return v.isSet +} + +func (v *NullableNotificationErrorContainer) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableNotificationErrorContainer(val *NotificationErrorContainer) *NullableNotificationErrorContainer { + return &NullableNotificationErrorContainer{value: val, isSet: true} +} + +func (v NullableNotificationErrorContainer) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableNotificationErrorContainer) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_notification_response.go b/src/platformsnotificationevents/model_notification_response.go new file mode 100644 index 000000000..421d08ebf --- /dev/null +++ b/src/platformsnotificationevents/model_notification_response.go @@ -0,0 +1,117 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// NotificationResponse struct for NotificationResponse +type NotificationResponse struct { + // Set this parameter to **[accepted]** to acknowledge that you received a notification from Adyen. + NotificationResponse *string `json:"notificationResponse,omitempty"` +} + +// NewNotificationResponse instantiates a new NotificationResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewNotificationResponse() *NotificationResponse { + this := NotificationResponse{} + return &this +} + +// NewNotificationResponseWithDefaults instantiates a new NotificationResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewNotificationResponseWithDefaults() *NotificationResponse { + this := NotificationResponse{} + return &this +} + +// GetNotificationResponse returns the NotificationResponse field value if set, zero value otherwise. +func (o *NotificationResponse) GetNotificationResponse() string { + if o == nil || o.NotificationResponse == nil { + var ret string + return ret + } + return *o.NotificationResponse +} + +// GetNotificationResponseOk returns a tuple with the NotificationResponse field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *NotificationResponse) GetNotificationResponseOk() (*string, bool) { + if o == nil || o.NotificationResponse == nil { + return nil, false + } + return o.NotificationResponse, true +} + +// HasNotificationResponse returns a boolean if a field has been set. +func (o *NotificationResponse) HasNotificationResponse() bool { + if o != nil && o.NotificationResponse != nil { + return true + } + + return false +} + +// SetNotificationResponse gets a reference to the given string and assigns it to the NotificationResponse field. +func (o *NotificationResponse) SetNotificationResponse(v string) { + o.NotificationResponse = &v +} + +func (o NotificationResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.NotificationResponse != nil { + toSerialize["notificationResponse"] = o.NotificationResponse + } + return json.Marshal(toSerialize) +} + +type NullableNotificationResponse struct { + value *NotificationResponse + isSet bool +} + +func (v NullableNotificationResponse) Get() *NotificationResponse { + return v.value +} + +func (v *NullableNotificationResponse) Set(val *NotificationResponse) { + v.value = val + v.isSet = true +} + +func (v NullableNotificationResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableNotificationResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableNotificationResponse(val *NotificationResponse) *NullableNotificationResponse { + return &NullableNotificationResponse{value: val, isSet: true} +} + +func (v NullableNotificationResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableNotificationResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_operation_status.go b/src/platformsnotificationevents/model_operation_status.go new file mode 100644 index 000000000..a3fe24ed0 --- /dev/null +++ b/src/platformsnotificationevents/model_operation_status.go @@ -0,0 +1,153 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// OperationStatus struct for OperationStatus +type OperationStatus struct { + Message *Message `json:"message,omitempty"` + // The status code. + StatusCode *string `json:"statusCode,omitempty"` +} + +// NewOperationStatus instantiates a new OperationStatus object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewOperationStatus() *OperationStatus { + this := OperationStatus{} + return &this +} + +// NewOperationStatusWithDefaults instantiates a new OperationStatus object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewOperationStatusWithDefaults() *OperationStatus { + this := OperationStatus{} + return &this +} + +// GetMessage returns the Message field value if set, zero value otherwise. +func (o *OperationStatus) GetMessage() Message { + if o == nil || o.Message == nil { + var ret Message + return ret + } + return *o.Message +} + +// GetMessageOk returns a tuple with the Message field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *OperationStatus) GetMessageOk() (*Message, bool) { + if o == nil || o.Message == nil { + return nil, false + } + return o.Message, true +} + +// HasMessage returns a boolean if a field has been set. +func (o *OperationStatus) HasMessage() bool { + if o != nil && o.Message != nil { + return true + } + + return false +} + +// SetMessage gets a reference to the given Message and assigns it to the Message field. +func (o *OperationStatus) SetMessage(v Message) { + o.Message = &v +} + +// GetStatusCode returns the StatusCode field value if set, zero value otherwise. +func (o *OperationStatus) GetStatusCode() string { + if o == nil || o.StatusCode == nil { + var ret string + return ret + } + return *o.StatusCode +} + +// GetStatusCodeOk returns a tuple with the StatusCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *OperationStatus) GetStatusCodeOk() (*string, bool) { + if o == nil || o.StatusCode == nil { + return nil, false + } + return o.StatusCode, true +} + +// HasStatusCode returns a boolean if a field has been set. +func (o *OperationStatus) HasStatusCode() bool { + if o != nil && o.StatusCode != nil { + return true + } + + return false +} + +// SetStatusCode gets a reference to the given string and assigns it to the StatusCode field. +func (o *OperationStatus) SetStatusCode(v string) { + o.StatusCode = &v +} + +func (o OperationStatus) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Message != nil { + toSerialize["message"] = o.Message + } + if o.StatusCode != nil { + toSerialize["statusCode"] = o.StatusCode + } + return json.Marshal(toSerialize) +} + +type NullableOperationStatus struct { + value *OperationStatus + isSet bool +} + +func (v NullableOperationStatus) Get() *OperationStatus { + return v.value +} + +func (v *NullableOperationStatus) Set(val *OperationStatus) { + v.value = val + v.isSet = true +} + +func (v NullableOperationStatus) IsSet() bool { + return v.isSet +} + +func (v *NullableOperationStatus) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableOperationStatus(val *OperationStatus) *NullableOperationStatus { + return &NullableOperationStatus{value: val, isSet: true} +} + +func (v NullableOperationStatus) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableOperationStatus) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_payment_failure_notification.go b/src/platformsnotificationevents/model_payment_failure_notification.go new file mode 100644 index 000000000..43e1fb912 --- /dev/null +++ b/src/platformsnotificationevents/model_payment_failure_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// PaymentFailureNotification struct for PaymentFailureNotification +type PaymentFailureNotification struct { + Content PaymentFailureNotificationContent `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewPaymentFailureNotification instantiates a new PaymentFailureNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewPaymentFailureNotification(content PaymentFailureNotificationContent, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *PaymentFailureNotification { + this := PaymentFailureNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewPaymentFailureNotificationWithDefaults instantiates a new PaymentFailureNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewPaymentFailureNotificationWithDefaults() *PaymentFailureNotification { + this := PaymentFailureNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *PaymentFailureNotification) GetContent() PaymentFailureNotificationContent { + if o == nil { + var ret PaymentFailureNotificationContent + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *PaymentFailureNotification) GetContentOk() (*PaymentFailureNotificationContent, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *PaymentFailureNotification) SetContent(v PaymentFailureNotificationContent) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *PaymentFailureNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PaymentFailureNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *PaymentFailureNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *PaymentFailureNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *PaymentFailureNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *PaymentFailureNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *PaymentFailureNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *PaymentFailureNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *PaymentFailureNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *PaymentFailureNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *PaymentFailureNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *PaymentFailureNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *PaymentFailureNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *PaymentFailureNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *PaymentFailureNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *PaymentFailureNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *PaymentFailureNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *PaymentFailureNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *PaymentFailureNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o PaymentFailureNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullablePaymentFailureNotification struct { + value *PaymentFailureNotification + isSet bool +} + +func (v NullablePaymentFailureNotification) Get() *PaymentFailureNotification { + return v.value +} + +func (v *NullablePaymentFailureNotification) Set(val *PaymentFailureNotification) { + v.value = val + v.isSet = true +} + +func (v NullablePaymentFailureNotification) IsSet() bool { + return v.isSet +} + +func (v *NullablePaymentFailureNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullablePaymentFailureNotification(val *PaymentFailureNotification) *NullablePaymentFailureNotification { + return &NullablePaymentFailureNotification{value: val, isSet: true} +} + +func (v NullablePaymentFailureNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullablePaymentFailureNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_payment_failure_notification_content.go b/src/platformsnotificationevents/model_payment_failure_notification_content.go new file mode 100644 index 000000000..f4f279110 --- /dev/null +++ b/src/platformsnotificationevents/model_payment_failure_notification_content.go @@ -0,0 +1,139 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// PaymentFailureNotificationContent struct for PaymentFailureNotificationContent +type PaymentFailureNotificationContent struct { + // Missing or invalid fields that caused the payment error. + ErrorFields []ErrorFieldType `json:"errorFields"` + ErrorMessage Message `json:"errorMessage"` +} + +// NewPaymentFailureNotificationContent instantiates a new PaymentFailureNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewPaymentFailureNotificationContent(errorFields []ErrorFieldType, errorMessage Message, ) *PaymentFailureNotificationContent { + this := PaymentFailureNotificationContent{} + this.ErrorFields = errorFields + this.ErrorMessage = errorMessage + return &this +} + +// NewPaymentFailureNotificationContentWithDefaults instantiates a new PaymentFailureNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewPaymentFailureNotificationContentWithDefaults() *PaymentFailureNotificationContent { + this := PaymentFailureNotificationContent{} + return &this +} + +// GetErrorFields returns the ErrorFields field value +func (o *PaymentFailureNotificationContent) GetErrorFields() []ErrorFieldType { + if o == nil { + var ret []ErrorFieldType + return ret + } + + return o.ErrorFields +} + +// GetErrorFieldsOk returns a tuple with the ErrorFields field value +// and a boolean to check if the value has been set. +func (o *PaymentFailureNotificationContent) GetErrorFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil { + return nil, false + } + return &o.ErrorFields, true +} + +// SetErrorFields sets field value +func (o *PaymentFailureNotificationContent) SetErrorFields(v []ErrorFieldType) { + o.ErrorFields = v +} + +// GetErrorMessage returns the ErrorMessage field value +func (o *PaymentFailureNotificationContent) GetErrorMessage() Message { + if o == nil { + var ret Message + return ret + } + + return o.ErrorMessage +} + +// GetErrorMessageOk returns a tuple with the ErrorMessage field value +// and a boolean to check if the value has been set. +func (o *PaymentFailureNotificationContent) GetErrorMessageOk() (*Message, bool) { + if o == nil { + return nil, false + } + return &o.ErrorMessage, true +} + +// SetErrorMessage sets field value +func (o *PaymentFailureNotificationContent) SetErrorMessage(v Message) { + o.ErrorMessage = v +} + +func (o PaymentFailureNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["errorFields"] = o.ErrorFields + } + if true { + toSerialize["errorMessage"] = o.ErrorMessage + } + return json.Marshal(toSerialize) +} + +type NullablePaymentFailureNotificationContent struct { + value *PaymentFailureNotificationContent + isSet bool +} + +func (v NullablePaymentFailureNotificationContent) Get() *PaymentFailureNotificationContent { + return v.value +} + +func (v *NullablePaymentFailureNotificationContent) Set(val *PaymentFailureNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullablePaymentFailureNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullablePaymentFailureNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullablePaymentFailureNotificationContent(val *PaymentFailureNotificationContent) *NullablePaymentFailureNotificationContent { + return &NullablePaymentFailureNotificationContent{value: val, isSet: true} +} + +func (v NullablePaymentFailureNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullablePaymentFailureNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_payout_method.go b/src/platformsnotificationevents/model_payout_method.go new file mode 100644 index 000000000..223cc937f --- /dev/null +++ b/src/platformsnotificationevents/model_payout_method.go @@ -0,0 +1,239 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// PayoutMethod struct for PayoutMethod +type PayoutMethod struct { + MerchantAccount string `json:"merchantAccount"` + PayoutMethodCode *string `json:"payoutMethodCode,omitempty"` + PayoutMethodType *string `json:"payoutMethodType,omitempty"` + RecurringDetailReference string `json:"recurringDetailReference"` + ShopperReference string `json:"shopperReference"` +} + +// NewPayoutMethod instantiates a new PayoutMethod object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewPayoutMethod(merchantAccount string, recurringDetailReference string, shopperReference string, ) *PayoutMethod { + this := PayoutMethod{} + this.MerchantAccount = merchantAccount + this.RecurringDetailReference = recurringDetailReference + this.ShopperReference = shopperReference + return &this +} + +// NewPayoutMethodWithDefaults instantiates a new PayoutMethod object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewPayoutMethodWithDefaults() *PayoutMethod { + this := PayoutMethod{} + return &this +} + +// GetMerchantAccount returns the MerchantAccount field value +func (o *PayoutMethod) GetMerchantAccount() string { + if o == nil { + var ret string + return ret + } + + return o.MerchantAccount +} + +// GetMerchantAccountOk returns a tuple with the MerchantAccount field value +// and a boolean to check if the value has been set. +func (o *PayoutMethod) GetMerchantAccountOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.MerchantAccount, true +} + +// SetMerchantAccount sets field value +func (o *PayoutMethod) SetMerchantAccount(v string) { + o.MerchantAccount = v +} + +// GetPayoutMethodCode returns the PayoutMethodCode field value if set, zero value otherwise. +func (o *PayoutMethod) GetPayoutMethodCode() string { + if o == nil || o.PayoutMethodCode == nil { + var ret string + return ret + } + return *o.PayoutMethodCode +} + +// GetPayoutMethodCodeOk returns a tuple with the PayoutMethodCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PayoutMethod) GetPayoutMethodCodeOk() (*string, bool) { + if o == nil || o.PayoutMethodCode == nil { + return nil, false + } + return o.PayoutMethodCode, true +} + +// HasPayoutMethodCode returns a boolean if a field has been set. +func (o *PayoutMethod) HasPayoutMethodCode() bool { + if o != nil && o.PayoutMethodCode != nil { + return true + } + + return false +} + +// SetPayoutMethodCode gets a reference to the given string and assigns it to the PayoutMethodCode field. +func (o *PayoutMethod) SetPayoutMethodCode(v string) { + o.PayoutMethodCode = &v +} + +// GetPayoutMethodType returns the PayoutMethodType field value if set, zero value otherwise. +func (o *PayoutMethod) GetPayoutMethodType() string { + if o == nil || o.PayoutMethodType == nil { + var ret string + return ret + } + return *o.PayoutMethodType +} + +// GetPayoutMethodTypeOk returns a tuple with the PayoutMethodType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PayoutMethod) GetPayoutMethodTypeOk() (*string, bool) { + if o == nil || o.PayoutMethodType == nil { + return nil, false + } + return o.PayoutMethodType, true +} + +// HasPayoutMethodType returns a boolean if a field has been set. +func (o *PayoutMethod) HasPayoutMethodType() bool { + if o != nil && o.PayoutMethodType != nil { + return true + } + + return false +} + +// SetPayoutMethodType gets a reference to the given string and assigns it to the PayoutMethodType field. +func (o *PayoutMethod) SetPayoutMethodType(v string) { + o.PayoutMethodType = &v +} + +// GetRecurringDetailReference returns the RecurringDetailReference field value +func (o *PayoutMethod) GetRecurringDetailReference() string { + if o == nil { + var ret string + return ret + } + + return o.RecurringDetailReference +} + +// GetRecurringDetailReferenceOk returns a tuple with the RecurringDetailReference field value +// and a boolean to check if the value has been set. +func (o *PayoutMethod) GetRecurringDetailReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.RecurringDetailReference, true +} + +// SetRecurringDetailReference sets field value +func (o *PayoutMethod) SetRecurringDetailReference(v string) { + o.RecurringDetailReference = v +} + +// GetShopperReference returns the ShopperReference field value +func (o *PayoutMethod) GetShopperReference() string { + if o == nil { + var ret string + return ret + } + + return o.ShopperReference +} + +// GetShopperReferenceOk returns a tuple with the ShopperReference field value +// and a boolean to check if the value has been set. +func (o *PayoutMethod) GetShopperReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ShopperReference, true +} + +// SetShopperReference sets field value +func (o *PayoutMethod) SetShopperReference(v string) { + o.ShopperReference = v +} + +func (o PayoutMethod) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["merchantAccount"] = o.MerchantAccount + } + if o.PayoutMethodCode != nil { + toSerialize["payoutMethodCode"] = o.PayoutMethodCode + } + if o.PayoutMethodType != nil { + toSerialize["payoutMethodType"] = o.PayoutMethodType + } + if true { + toSerialize["recurringDetailReference"] = o.RecurringDetailReference + } + if true { + toSerialize["shopperReference"] = o.ShopperReference + } + return json.Marshal(toSerialize) +} + +type NullablePayoutMethod struct { + value *PayoutMethod + isSet bool +} + +func (v NullablePayoutMethod) Get() *PayoutMethod { + return v.value +} + +func (v *NullablePayoutMethod) Set(val *PayoutMethod) { + v.value = val + v.isSet = true +} + +func (v NullablePayoutMethod) IsSet() bool { + return v.isSet +} + +func (v *NullablePayoutMethod) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullablePayoutMethod(val *PayoutMethod) *NullablePayoutMethod { + return &NullablePayoutMethod{value: val, isSet: true} +} + +func (v NullablePayoutMethod) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullablePayoutMethod) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_payout_schedule_response.go b/src/platformsnotificationevents/model_payout_schedule_response.go new file mode 100644 index 000000000..2a0c0acb4 --- /dev/null +++ b/src/platformsnotificationevents/model_payout_schedule_response.go @@ -0,0 +1,141 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// PayoutScheduleResponse struct for PayoutScheduleResponse +type PayoutScheduleResponse struct { + // The date of the next scheduled payout. + NextScheduledPayout time.Time `json:"nextScheduledPayout"` + // The payout schedule of the account. >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. + Schedule string `json:"schedule"` +} + +// NewPayoutScheduleResponse instantiates a new PayoutScheduleResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewPayoutScheduleResponse(nextScheduledPayout time.Time, schedule string, ) *PayoutScheduleResponse { + this := PayoutScheduleResponse{} + this.NextScheduledPayout = nextScheduledPayout + this.Schedule = schedule + return &this +} + +// NewPayoutScheduleResponseWithDefaults instantiates a new PayoutScheduleResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewPayoutScheduleResponseWithDefaults() *PayoutScheduleResponse { + this := PayoutScheduleResponse{} + return &this +} + +// GetNextScheduledPayout returns the NextScheduledPayout field value +func (o *PayoutScheduleResponse) GetNextScheduledPayout() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.NextScheduledPayout +} + +// GetNextScheduledPayoutOk returns a tuple with the NextScheduledPayout field value +// and a boolean to check if the value has been set. +func (o *PayoutScheduleResponse) GetNextScheduledPayoutOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.NextScheduledPayout, true +} + +// SetNextScheduledPayout sets field value +func (o *PayoutScheduleResponse) SetNextScheduledPayout(v time.Time) { + o.NextScheduledPayout = v +} + +// GetSchedule returns the Schedule field value +func (o *PayoutScheduleResponse) GetSchedule() string { + if o == nil { + var ret string + return ret + } + + return o.Schedule +} + +// GetScheduleOk returns a tuple with the Schedule field value +// and a boolean to check if the value has been set. +func (o *PayoutScheduleResponse) GetScheduleOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Schedule, true +} + +// SetSchedule sets field value +func (o *PayoutScheduleResponse) SetSchedule(v string) { + o.Schedule = v +} + +func (o PayoutScheduleResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["nextScheduledPayout"] = o.NextScheduledPayout + } + if true { + toSerialize["schedule"] = o.Schedule + } + return json.Marshal(toSerialize) +} + +type NullablePayoutScheduleResponse struct { + value *PayoutScheduleResponse + isSet bool +} + +func (v NullablePayoutScheduleResponse) Get() *PayoutScheduleResponse { + return v.value +} + +func (v *NullablePayoutScheduleResponse) Set(val *PayoutScheduleResponse) { + v.value = val + v.isSet = true +} + +func (v NullablePayoutScheduleResponse) IsSet() bool { + return v.isSet +} + +func (v *NullablePayoutScheduleResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullablePayoutScheduleResponse(val *PayoutScheduleResponse) *NullablePayoutScheduleResponse { + return &NullablePayoutScheduleResponse{value: val, isSet: true} +} + +func (v NullablePayoutScheduleResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullablePayoutScheduleResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_personal_document_data.go b/src/platformsnotificationevents/model_personal_document_data.go new file mode 100644 index 000000000..a4a023f85 --- /dev/null +++ b/src/platformsnotificationevents/model_personal_document_data.go @@ -0,0 +1,258 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// PersonalDocumentData struct for PersonalDocumentData +type PersonalDocumentData struct { + // The expiration date of the document. The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31). + ExpirationDate *string `json:"expirationDate,omitempty"` + // The two-character country code of the issuer. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). + IssuerCountry *string `json:"issuerCountry,omitempty"` + // The state issued the document (if applicable) + IssuerState *string `json:"issuerState,omitempty"` + // The number of the document. Delete the given type if the value empty. + Number *string `json:"number,omitempty"` + // The type of the document. More then one item pert type does not allowed. Valid values: ID, PASSPORT, VISA, DRIVINGLICENSE + Type string `json:"type"` +} + +// NewPersonalDocumentData instantiates a new PersonalDocumentData object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewPersonalDocumentData(type_ string, ) *PersonalDocumentData { + this := PersonalDocumentData{} + this.Type = type_ + return &this +} + +// NewPersonalDocumentDataWithDefaults instantiates a new PersonalDocumentData object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewPersonalDocumentDataWithDefaults() *PersonalDocumentData { + this := PersonalDocumentData{} + return &this +} + +// GetExpirationDate returns the ExpirationDate field value if set, zero value otherwise. +func (o *PersonalDocumentData) GetExpirationDate() string { + if o == nil || o.ExpirationDate == nil { + var ret string + return ret + } + return *o.ExpirationDate +} + +// GetExpirationDateOk returns a tuple with the ExpirationDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PersonalDocumentData) GetExpirationDateOk() (*string, bool) { + if o == nil || o.ExpirationDate == nil { + return nil, false + } + return o.ExpirationDate, true +} + +// HasExpirationDate returns a boolean if a field has been set. +func (o *PersonalDocumentData) HasExpirationDate() bool { + if o != nil && o.ExpirationDate != nil { + return true + } + + return false +} + +// SetExpirationDate gets a reference to the given string and assigns it to the ExpirationDate field. +func (o *PersonalDocumentData) SetExpirationDate(v string) { + o.ExpirationDate = &v +} + +// GetIssuerCountry returns the IssuerCountry field value if set, zero value otherwise. +func (o *PersonalDocumentData) GetIssuerCountry() string { + if o == nil || o.IssuerCountry == nil { + var ret string + return ret + } + return *o.IssuerCountry +} + +// GetIssuerCountryOk returns a tuple with the IssuerCountry field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PersonalDocumentData) GetIssuerCountryOk() (*string, bool) { + if o == nil || o.IssuerCountry == nil { + return nil, false + } + return o.IssuerCountry, true +} + +// HasIssuerCountry returns a boolean if a field has been set. +func (o *PersonalDocumentData) HasIssuerCountry() bool { + if o != nil && o.IssuerCountry != nil { + return true + } + + return false +} + +// SetIssuerCountry gets a reference to the given string and assigns it to the IssuerCountry field. +func (o *PersonalDocumentData) SetIssuerCountry(v string) { + o.IssuerCountry = &v +} + +// GetIssuerState returns the IssuerState field value if set, zero value otherwise. +func (o *PersonalDocumentData) GetIssuerState() string { + if o == nil || o.IssuerState == nil { + var ret string + return ret + } + return *o.IssuerState +} + +// GetIssuerStateOk returns a tuple with the IssuerState field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PersonalDocumentData) GetIssuerStateOk() (*string, bool) { + if o == nil || o.IssuerState == nil { + return nil, false + } + return o.IssuerState, true +} + +// HasIssuerState returns a boolean if a field has been set. +func (o *PersonalDocumentData) HasIssuerState() bool { + if o != nil && o.IssuerState != nil { + return true + } + + return false +} + +// SetIssuerState gets a reference to the given string and assigns it to the IssuerState field. +func (o *PersonalDocumentData) SetIssuerState(v string) { + o.IssuerState = &v +} + +// GetNumber returns the Number field value if set, zero value otherwise. +func (o *PersonalDocumentData) GetNumber() string { + if o == nil || o.Number == nil { + var ret string + return ret + } + return *o.Number +} + +// GetNumberOk returns a tuple with the Number field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *PersonalDocumentData) GetNumberOk() (*string, bool) { + if o == nil || o.Number == nil { + return nil, false + } + return o.Number, true +} + +// HasNumber returns a boolean if a field has been set. +func (o *PersonalDocumentData) HasNumber() bool { + if o != nil && o.Number != nil { + return true + } + + return false +} + +// SetNumber gets a reference to the given string and assigns it to the Number field. +func (o *PersonalDocumentData) SetNumber(v string) { + o.Number = &v +} + +// GetType returns the Type field value +func (o *PersonalDocumentData) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// GetTypeOk returns a tuple with the Type field value +// and a boolean to check if the value has been set. +func (o *PersonalDocumentData) GetTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Type, true +} + +// SetType sets field value +func (o *PersonalDocumentData) SetType(v string) { + o.Type = v +} + +func (o PersonalDocumentData) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.ExpirationDate != nil { + toSerialize["expirationDate"] = o.ExpirationDate + } + if o.IssuerCountry != nil { + toSerialize["issuerCountry"] = o.IssuerCountry + } + if o.IssuerState != nil { + toSerialize["issuerState"] = o.IssuerState + } + if o.Number != nil { + toSerialize["number"] = o.Number + } + if true { + toSerialize["type"] = o.Type + } + return json.Marshal(toSerialize) +} + +type NullablePersonalDocumentData struct { + value *PersonalDocumentData + isSet bool +} + +func (v NullablePersonalDocumentData) Get() *PersonalDocumentData { + return v.value +} + +func (v *NullablePersonalDocumentData) Set(val *PersonalDocumentData) { + v.value = val + v.isSet = true +} + +func (v NullablePersonalDocumentData) IsSet() bool { + return v.isSet +} + +func (v *NullablePersonalDocumentData) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullablePersonalDocumentData(val *PersonalDocumentData) *NullablePersonalDocumentData { + return &NullablePersonalDocumentData{value: val, isSet: true} +} + +func (v NullablePersonalDocumentData) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullablePersonalDocumentData) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_refund_funds_transfer_notification.go b/src/platformsnotificationevents/model_refund_funds_transfer_notification.go new file mode 100644 index 000000000..42769eec6 --- /dev/null +++ b/src/platformsnotificationevents/model_refund_funds_transfer_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// RefundFundsTransferNotification struct for RefundFundsTransferNotification +type RefundFundsTransferNotification struct { + Content RefundFundsTransferNotificationContent `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewRefundFundsTransferNotification instantiates a new RefundFundsTransferNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewRefundFundsTransferNotification(content RefundFundsTransferNotificationContent, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *RefundFundsTransferNotification { + this := RefundFundsTransferNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewRefundFundsTransferNotificationWithDefaults instantiates a new RefundFundsTransferNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewRefundFundsTransferNotificationWithDefaults() *RefundFundsTransferNotification { + this := RefundFundsTransferNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *RefundFundsTransferNotification) GetContent() RefundFundsTransferNotificationContent { + if o == nil { + var ret RefundFundsTransferNotificationContent + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotification) GetContentOk() (*RefundFundsTransferNotificationContent, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *RefundFundsTransferNotification) SetContent(v RefundFundsTransferNotificationContent) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *RefundFundsTransferNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *RefundFundsTransferNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *RefundFundsTransferNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *RefundFundsTransferNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *RefundFundsTransferNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *RefundFundsTransferNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *RefundFundsTransferNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *RefundFundsTransferNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *RefundFundsTransferNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *RefundFundsTransferNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *RefundFundsTransferNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *RefundFundsTransferNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *RefundFundsTransferNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o RefundFundsTransferNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableRefundFundsTransferNotification struct { + value *RefundFundsTransferNotification + isSet bool +} + +func (v NullableRefundFundsTransferNotification) Get() *RefundFundsTransferNotification { + return v.value +} + +func (v *NullableRefundFundsTransferNotification) Set(val *RefundFundsTransferNotification) { + v.value = val + v.isSet = true +} + +func (v NullableRefundFundsTransferNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableRefundFundsTransferNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableRefundFundsTransferNotification(val *RefundFundsTransferNotification) *NullableRefundFundsTransferNotification { + return &NullableRefundFundsTransferNotification{value: val, isSet: true} +} + +func (v NullableRefundFundsTransferNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableRefundFundsTransferNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_refund_funds_transfer_notification_content.go b/src/platformsnotificationevents/model_refund_funds_transfer_notification_content.go new file mode 100644 index 000000000..017001136 --- /dev/null +++ b/src/platformsnotificationevents/model_refund_funds_transfer_notification_content.go @@ -0,0 +1,249 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// RefundFundsTransferNotificationContent struct for RefundFundsTransferNotificationContent +type RefundFundsTransferNotificationContent struct { + Amount Amount `json:"amount"` + // Invalid fields list. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + // A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another. + MerchantReference *string `json:"merchantReference,omitempty"` + // A PSP reference of the original fund transfer. + OriginalReference string `json:"originalReference"` + Status *OperationStatus `json:"status,omitempty"` +} + +// NewRefundFundsTransferNotificationContent instantiates a new RefundFundsTransferNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewRefundFundsTransferNotificationContent(amount Amount, originalReference string, ) *RefundFundsTransferNotificationContent { + this := RefundFundsTransferNotificationContent{} + this.Amount = amount + this.OriginalReference = originalReference + return &this +} + +// NewRefundFundsTransferNotificationContentWithDefaults instantiates a new RefundFundsTransferNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewRefundFundsTransferNotificationContentWithDefaults() *RefundFundsTransferNotificationContent { + this := RefundFundsTransferNotificationContent{} + return &this +} + +// GetAmount returns the Amount field value +func (o *RefundFundsTransferNotificationContent) GetAmount() Amount { + if o == nil { + var ret Amount + return ret + } + + return o.Amount +} + +// GetAmountOk returns a tuple with the Amount field value +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotificationContent) GetAmountOk() (*Amount, bool) { + if o == nil { + return nil, false + } + return &o.Amount, true +} + +// SetAmount sets field value +func (o *RefundFundsTransferNotificationContent) SetAmount(v Amount) { + o.Amount = v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *RefundFundsTransferNotificationContent) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotificationContent) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *RefundFundsTransferNotificationContent) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *RefundFundsTransferNotificationContent) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetMerchantReference returns the MerchantReference field value if set, zero value otherwise. +func (o *RefundFundsTransferNotificationContent) GetMerchantReference() string { + if o == nil || o.MerchantReference == nil { + var ret string + return ret + } + return *o.MerchantReference +} + +// GetMerchantReferenceOk returns a tuple with the MerchantReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotificationContent) GetMerchantReferenceOk() (*string, bool) { + if o == nil || o.MerchantReference == nil { + return nil, false + } + return o.MerchantReference, true +} + +// HasMerchantReference returns a boolean if a field has been set. +func (o *RefundFundsTransferNotificationContent) HasMerchantReference() bool { + if o != nil && o.MerchantReference != nil { + return true + } + + return false +} + +// SetMerchantReference gets a reference to the given string and assigns it to the MerchantReference field. +func (o *RefundFundsTransferNotificationContent) SetMerchantReference(v string) { + o.MerchantReference = &v +} + +// GetOriginalReference returns the OriginalReference field value +func (o *RefundFundsTransferNotificationContent) GetOriginalReference() string { + if o == nil { + var ret string + return ret + } + + return o.OriginalReference +} + +// GetOriginalReferenceOk returns a tuple with the OriginalReference field value +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotificationContent) GetOriginalReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.OriginalReference, true +} + +// SetOriginalReference sets field value +func (o *RefundFundsTransferNotificationContent) SetOriginalReference(v string) { + o.OriginalReference = v +} + +// GetStatus returns the Status field value if set, zero value otherwise. +func (o *RefundFundsTransferNotificationContent) GetStatus() OperationStatus { + if o == nil || o.Status == nil { + var ret OperationStatus + return ret + } + return *o.Status +} + +// GetStatusOk returns a tuple with the Status field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *RefundFundsTransferNotificationContent) GetStatusOk() (*OperationStatus, bool) { + if o == nil || o.Status == nil { + return nil, false + } + return o.Status, true +} + +// HasStatus returns a boolean if a field has been set. +func (o *RefundFundsTransferNotificationContent) HasStatus() bool { + if o != nil && o.Status != nil { + return true + } + + return false +} + +// SetStatus gets a reference to the given OperationStatus and assigns it to the Status field. +func (o *RefundFundsTransferNotificationContent) SetStatus(v OperationStatus) { + o.Status = &v +} + +func (o RefundFundsTransferNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["amount"] = o.Amount + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if o.MerchantReference != nil { + toSerialize["merchantReference"] = o.MerchantReference + } + if true { + toSerialize["originalReference"] = o.OriginalReference + } + if o.Status != nil { + toSerialize["status"] = o.Status + } + return json.Marshal(toSerialize) +} + +type NullableRefundFundsTransferNotificationContent struct { + value *RefundFundsTransferNotificationContent + isSet bool +} + +func (v NullableRefundFundsTransferNotificationContent) Get() *RefundFundsTransferNotificationContent { + return v.value +} + +func (v *NullableRefundFundsTransferNotificationContent) Set(val *RefundFundsTransferNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableRefundFundsTransferNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableRefundFundsTransferNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableRefundFundsTransferNotificationContent(val *RefundFundsTransferNotificationContent) *NullableRefundFundsTransferNotificationContent { + return &NullableRefundFundsTransferNotificationContent{value: val, isSet: true} +} + +func (v NullableRefundFundsTransferNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableRefundFundsTransferNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_refund_result.go b/src/platformsnotificationevents/model_refund_result.go new file mode 100644 index 000000000..a668e1817 --- /dev/null +++ b/src/platformsnotificationevents/model_refund_result.go @@ -0,0 +1,176 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// RefundResult struct for RefundResult +type RefundResult struct { + OriginalTransaction Transaction `json:"originalTransaction"` + // The reference of the refund. + PspReference string `json:"pspReference"` + // The response indicating if the refund has been received for processing. + Response *string `json:"response,omitempty"` +} + +// NewRefundResult instantiates a new RefundResult object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewRefundResult(originalTransaction Transaction, pspReference string, ) *RefundResult { + this := RefundResult{} + this.OriginalTransaction = originalTransaction + this.PspReference = pspReference + return &this +} + +// NewRefundResultWithDefaults instantiates a new RefundResult object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewRefundResultWithDefaults() *RefundResult { + this := RefundResult{} + return &this +} + +// GetOriginalTransaction returns the OriginalTransaction field value +func (o *RefundResult) GetOriginalTransaction() Transaction { + if o == nil { + var ret Transaction + return ret + } + + return o.OriginalTransaction +} + +// GetOriginalTransactionOk returns a tuple with the OriginalTransaction field value +// and a boolean to check if the value has been set. +func (o *RefundResult) GetOriginalTransactionOk() (*Transaction, bool) { + if o == nil { + return nil, false + } + return &o.OriginalTransaction, true +} + +// SetOriginalTransaction sets field value +func (o *RefundResult) SetOriginalTransaction(v Transaction) { + o.OriginalTransaction = v +} + +// GetPspReference returns the PspReference field value +func (o *RefundResult) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *RefundResult) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *RefundResult) SetPspReference(v string) { + o.PspReference = v +} + +// GetResponse returns the Response field value if set, zero value otherwise. +func (o *RefundResult) GetResponse() string { + if o == nil || o.Response == nil { + var ret string + return ret + } + return *o.Response +} + +// GetResponseOk returns a tuple with the Response field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *RefundResult) GetResponseOk() (*string, bool) { + if o == nil || o.Response == nil { + return nil, false + } + return o.Response, true +} + +// HasResponse returns a boolean if a field has been set. +func (o *RefundResult) HasResponse() bool { + if o != nil && o.Response != nil { + return true + } + + return false +} + +// SetResponse gets a reference to the given string and assigns it to the Response field. +func (o *RefundResult) SetResponse(v string) { + o.Response = &v +} + +func (o RefundResult) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["originalTransaction"] = o.OriginalTransaction + } + if true { + toSerialize["pspReference"] = o.PspReference + } + if o.Response != nil { + toSerialize["response"] = o.Response + } + return json.Marshal(toSerialize) +} + +type NullableRefundResult struct { + value *RefundResult + isSet bool +} + +func (v NullableRefundResult) Get() *RefundResult { + return v.value +} + +func (v *NullableRefundResult) Set(val *RefundResult) { + v.value = val + v.isSet = true +} + +func (v NullableRefundResult) IsSet() bool { + return v.isSet +} + +func (v *NullableRefundResult) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableRefundResult(val *RefundResult) *NullableRefundResult { + return &NullableRefundResult{value: val, isSet: true} +} + +func (v NullableRefundResult) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableRefundResult) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_report_available_notification.go b/src/platformsnotificationevents/model_report_available_notification.go new file mode 100644 index 000000000..6c69db2d6 --- /dev/null +++ b/src/platformsnotificationevents/model_report_available_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// ReportAvailableNotification struct for ReportAvailableNotification +type ReportAvailableNotification struct { + Content ReportAvailableNotificationContent `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewReportAvailableNotification instantiates a new ReportAvailableNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReportAvailableNotification(content ReportAvailableNotificationContent, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *ReportAvailableNotification { + this := ReportAvailableNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewReportAvailableNotificationWithDefaults instantiates a new ReportAvailableNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReportAvailableNotificationWithDefaults() *ReportAvailableNotification { + this := ReportAvailableNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *ReportAvailableNotification) GetContent() ReportAvailableNotificationContent { + if o == nil { + var ret ReportAvailableNotificationContent + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotification) GetContentOk() (*ReportAvailableNotificationContent, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *ReportAvailableNotification) SetContent(v ReportAvailableNotificationContent) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *ReportAvailableNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *ReportAvailableNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *ReportAvailableNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *ReportAvailableNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *ReportAvailableNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *ReportAvailableNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *ReportAvailableNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *ReportAvailableNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *ReportAvailableNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *ReportAvailableNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *ReportAvailableNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *ReportAvailableNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *ReportAvailableNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o ReportAvailableNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableReportAvailableNotification struct { + value *ReportAvailableNotification + isSet bool +} + +func (v NullableReportAvailableNotification) Get() *ReportAvailableNotification { + return v.value +} + +func (v *NullableReportAvailableNotification) Set(val *ReportAvailableNotification) { + v.value = val + v.isSet = true +} + +func (v NullableReportAvailableNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableReportAvailableNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReportAvailableNotification(val *ReportAvailableNotification) *NullableReportAvailableNotification { + return &NullableReportAvailableNotification{value: val, isSet: true} +} + +func (v NullableReportAvailableNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReportAvailableNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_report_available_notification_content.go b/src/platformsnotificationevents/model_report_available_notification_content.go new file mode 100644 index 000000000..74803352b --- /dev/null +++ b/src/platformsnotificationevents/model_report_available_notification_content.go @@ -0,0 +1,266 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// ReportAvailableNotificationContent struct for ReportAvailableNotificationContent +type ReportAvailableNotificationContent struct { + // The code of the Account to which the report applies. + AccountCode *string `json:"accountCode,omitempty"` + // The type of Account to which the report applies. + AccountType *string `json:"accountType,omitempty"` + // The date of the event to which the report applies. + EventDate *time.Time `json:"eventDate,omitempty"` + // The URL at which the report can be accessed. + RemoteAccessUrl *string `json:"remoteAccessUrl,omitempty"` + // Indicates whether the event resulted in a success. + Success *bool `json:"success,omitempty"` +} + +// NewReportAvailableNotificationContent instantiates a new ReportAvailableNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewReportAvailableNotificationContent() *ReportAvailableNotificationContent { + this := ReportAvailableNotificationContent{} + return &this +} + +// NewReportAvailableNotificationContentWithDefaults instantiates a new ReportAvailableNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewReportAvailableNotificationContentWithDefaults() *ReportAvailableNotificationContent { + this := ReportAvailableNotificationContent{} + return &this +} + +// GetAccountCode returns the AccountCode field value if set, zero value otherwise. +func (o *ReportAvailableNotificationContent) GetAccountCode() string { + if o == nil || o.AccountCode == nil { + var ret string + return ret + } + return *o.AccountCode +} + +// GetAccountCodeOk returns a tuple with the AccountCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotificationContent) GetAccountCodeOk() (*string, bool) { + if o == nil || o.AccountCode == nil { + return nil, false + } + return o.AccountCode, true +} + +// HasAccountCode returns a boolean if a field has been set. +func (o *ReportAvailableNotificationContent) HasAccountCode() bool { + if o != nil && o.AccountCode != nil { + return true + } + + return false +} + +// SetAccountCode gets a reference to the given string and assigns it to the AccountCode field. +func (o *ReportAvailableNotificationContent) SetAccountCode(v string) { + o.AccountCode = &v +} + +// GetAccountType returns the AccountType field value if set, zero value otherwise. +func (o *ReportAvailableNotificationContent) GetAccountType() string { + if o == nil || o.AccountType == nil { + var ret string + return ret + } + return *o.AccountType +} + +// GetAccountTypeOk returns a tuple with the AccountType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotificationContent) GetAccountTypeOk() (*string, bool) { + if o == nil || o.AccountType == nil { + return nil, false + } + return o.AccountType, true +} + +// HasAccountType returns a boolean if a field has been set. +func (o *ReportAvailableNotificationContent) HasAccountType() bool { + if o != nil && o.AccountType != nil { + return true + } + + return false +} + +// SetAccountType gets a reference to the given string and assigns it to the AccountType field. +func (o *ReportAvailableNotificationContent) SetAccountType(v string) { + o.AccountType = &v +} + +// GetEventDate returns the EventDate field value if set, zero value otherwise. +func (o *ReportAvailableNotificationContent) GetEventDate() time.Time { + if o == nil || o.EventDate == nil { + var ret time.Time + return ret + } + return *o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotificationContent) GetEventDateOk() (*time.Time, bool) { + if o == nil || o.EventDate == nil { + return nil, false + } + return o.EventDate, true +} + +// HasEventDate returns a boolean if a field has been set. +func (o *ReportAvailableNotificationContent) HasEventDate() bool { + if o != nil && o.EventDate != nil { + return true + } + + return false +} + +// SetEventDate gets a reference to the given time.Time and assigns it to the EventDate field. +func (o *ReportAvailableNotificationContent) SetEventDate(v time.Time) { + o.EventDate = &v +} + +// GetRemoteAccessUrl returns the RemoteAccessUrl field value if set, zero value otherwise. +func (o *ReportAvailableNotificationContent) GetRemoteAccessUrl() string { + if o == nil || o.RemoteAccessUrl == nil { + var ret string + return ret + } + return *o.RemoteAccessUrl +} + +// GetRemoteAccessUrlOk returns a tuple with the RemoteAccessUrl field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotificationContent) GetRemoteAccessUrlOk() (*string, bool) { + if o == nil || o.RemoteAccessUrl == nil { + return nil, false + } + return o.RemoteAccessUrl, true +} + +// HasRemoteAccessUrl returns a boolean if a field has been set. +func (o *ReportAvailableNotificationContent) HasRemoteAccessUrl() bool { + if o != nil && o.RemoteAccessUrl != nil { + return true + } + + return false +} + +// SetRemoteAccessUrl gets a reference to the given string and assigns it to the RemoteAccessUrl field. +func (o *ReportAvailableNotificationContent) SetRemoteAccessUrl(v string) { + o.RemoteAccessUrl = &v +} + +// GetSuccess returns the Success field value if set, zero value otherwise. +func (o *ReportAvailableNotificationContent) GetSuccess() bool { + if o == nil || o.Success == nil { + var ret bool + return ret + } + return *o.Success +} + +// GetSuccessOk returns a tuple with the Success field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ReportAvailableNotificationContent) GetSuccessOk() (*bool, bool) { + if o == nil || o.Success == nil { + return nil, false + } + return o.Success, true +} + +// HasSuccess returns a boolean if a field has been set. +func (o *ReportAvailableNotificationContent) HasSuccess() bool { + if o != nil && o.Success != nil { + return true + } + + return false +} + +// SetSuccess gets a reference to the given bool and assigns it to the Success field. +func (o *ReportAvailableNotificationContent) SetSuccess(v bool) { + o.Success = &v +} + +func (o ReportAvailableNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.AccountCode != nil { + toSerialize["accountCode"] = o.AccountCode + } + if o.AccountType != nil { + toSerialize["accountType"] = o.AccountType + } + if o.EventDate != nil { + toSerialize["eventDate"] = o.EventDate + } + if o.RemoteAccessUrl != nil { + toSerialize["remoteAccessUrl"] = o.RemoteAccessUrl + } + if o.Success != nil { + toSerialize["success"] = o.Success + } + return json.Marshal(toSerialize) +} + +type NullableReportAvailableNotificationContent struct { + value *ReportAvailableNotificationContent + isSet bool +} + +func (v NullableReportAvailableNotificationContent) Get() *ReportAvailableNotificationContent { + return v.value +} + +func (v *NullableReportAvailableNotificationContent) Set(val *ReportAvailableNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableReportAvailableNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableReportAvailableNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableReportAvailableNotificationContent(val *ReportAvailableNotificationContent) *NullableReportAvailableNotificationContent { + return &NullableReportAvailableNotificationContent{value: val, isSet: true} +} + +func (v NullableReportAvailableNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableReportAvailableNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_scheduled_refunds_notification.go b/src/platformsnotificationevents/model_scheduled_refunds_notification.go new file mode 100644 index 000000000..f23852b5e --- /dev/null +++ b/src/platformsnotificationevents/model_scheduled_refunds_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// ScheduledRefundsNotification struct for ScheduledRefundsNotification +type ScheduledRefundsNotification struct { + Content ScheduledRefundsNotificationContent `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewScheduledRefundsNotification instantiates a new ScheduledRefundsNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewScheduledRefundsNotification(content ScheduledRefundsNotificationContent, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *ScheduledRefundsNotification { + this := ScheduledRefundsNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewScheduledRefundsNotificationWithDefaults instantiates a new ScheduledRefundsNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewScheduledRefundsNotificationWithDefaults() *ScheduledRefundsNotification { + this := ScheduledRefundsNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *ScheduledRefundsNotification) GetContent() ScheduledRefundsNotificationContent { + if o == nil { + var ret ScheduledRefundsNotificationContent + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotification) GetContentOk() (*ScheduledRefundsNotificationContent, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *ScheduledRefundsNotification) SetContent(v ScheduledRefundsNotificationContent) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *ScheduledRefundsNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *ScheduledRefundsNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *ScheduledRefundsNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *ScheduledRefundsNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *ScheduledRefundsNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *ScheduledRefundsNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *ScheduledRefundsNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *ScheduledRefundsNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *ScheduledRefundsNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *ScheduledRefundsNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *ScheduledRefundsNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *ScheduledRefundsNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *ScheduledRefundsNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o ScheduledRefundsNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableScheduledRefundsNotification struct { + value *ScheduledRefundsNotification + isSet bool +} + +func (v NullableScheduledRefundsNotification) Get() *ScheduledRefundsNotification { + return v.value +} + +func (v *NullableScheduledRefundsNotification) Set(val *ScheduledRefundsNotification) { + v.value = val + v.isSet = true +} + +func (v NullableScheduledRefundsNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableScheduledRefundsNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableScheduledRefundsNotification(val *ScheduledRefundsNotification) *NullableScheduledRefundsNotification { + return &NullableScheduledRefundsNotification{value: val, isSet: true} +} + +func (v NullableScheduledRefundsNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableScheduledRefundsNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_scheduled_refunds_notification_content.go b/src/platformsnotificationevents/model_scheduled_refunds_notification_content.go new file mode 100644 index 000000000..af14f0066 --- /dev/null +++ b/src/platformsnotificationevents/model_scheduled_refunds_notification_content.go @@ -0,0 +1,236 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// ScheduledRefundsNotificationContent struct for ScheduledRefundsNotificationContent +type ScheduledRefundsNotificationContent struct { + // The code of the account. + AccountCode string `json:"accountCode"` + // The code of the Account Holder. + AccountHolderCode string `json:"accountHolderCode"` + // Invalid fields list. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + LastPayout Transaction `json:"lastPayout"` + // A list of the refunds that have been scheduled and their results. + RefundResults []RefundResult `json:"refundResults"` +} + +// NewScheduledRefundsNotificationContent instantiates a new ScheduledRefundsNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewScheduledRefundsNotificationContent(accountCode string, accountHolderCode string, lastPayout Transaction, refundResults []RefundResult, ) *ScheduledRefundsNotificationContent { + this := ScheduledRefundsNotificationContent{} + this.AccountCode = accountCode + this.AccountHolderCode = accountHolderCode + this.LastPayout = lastPayout + this.RefundResults = refundResults + return &this +} + +// NewScheduledRefundsNotificationContentWithDefaults instantiates a new ScheduledRefundsNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewScheduledRefundsNotificationContentWithDefaults() *ScheduledRefundsNotificationContent { + this := ScheduledRefundsNotificationContent{} + return &this +} + +// GetAccountCode returns the AccountCode field value +func (o *ScheduledRefundsNotificationContent) GetAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountCode +} + +// GetAccountCodeOk returns a tuple with the AccountCode field value +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotificationContent) GetAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountCode, true +} + +// SetAccountCode sets field value +func (o *ScheduledRefundsNotificationContent) SetAccountCode(v string) { + o.AccountCode = v +} + +// GetAccountHolderCode returns the AccountHolderCode field value +func (o *ScheduledRefundsNotificationContent) GetAccountHolderCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountHolderCode +} + +// GetAccountHolderCodeOk returns a tuple with the AccountHolderCode field value +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotificationContent) GetAccountHolderCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountHolderCode, true +} + +// SetAccountHolderCode sets field value +func (o *ScheduledRefundsNotificationContent) SetAccountHolderCode(v string) { + o.AccountHolderCode = v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *ScheduledRefundsNotificationContent) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotificationContent) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *ScheduledRefundsNotificationContent) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *ScheduledRefundsNotificationContent) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetLastPayout returns the LastPayout field value +func (o *ScheduledRefundsNotificationContent) GetLastPayout() Transaction { + if o == nil { + var ret Transaction + return ret + } + + return o.LastPayout +} + +// GetLastPayoutOk returns a tuple with the LastPayout field value +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotificationContent) GetLastPayoutOk() (*Transaction, bool) { + if o == nil { + return nil, false + } + return &o.LastPayout, true +} + +// SetLastPayout sets field value +func (o *ScheduledRefundsNotificationContent) SetLastPayout(v Transaction) { + o.LastPayout = v +} + +// GetRefundResults returns the RefundResults field value +func (o *ScheduledRefundsNotificationContent) GetRefundResults() []RefundResult { + if o == nil { + var ret []RefundResult + return ret + } + + return o.RefundResults +} + +// GetRefundResultsOk returns a tuple with the RefundResults field value +// and a boolean to check if the value has been set. +func (o *ScheduledRefundsNotificationContent) GetRefundResultsOk() (*[]RefundResult, bool) { + if o == nil { + return nil, false + } + return &o.RefundResults, true +} + +// SetRefundResults sets field value +func (o *ScheduledRefundsNotificationContent) SetRefundResults(v []RefundResult) { + o.RefundResults = v +} + +func (o ScheduledRefundsNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["accountCode"] = o.AccountCode + } + if true { + toSerialize["accountHolderCode"] = o.AccountHolderCode + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if true { + toSerialize["lastPayout"] = o.LastPayout + } + if true { + toSerialize["refundResults"] = o.RefundResults + } + return json.Marshal(toSerialize) +} + +type NullableScheduledRefundsNotificationContent struct { + value *ScheduledRefundsNotificationContent + isSet bool +} + +func (v NullableScheduledRefundsNotificationContent) Get() *ScheduledRefundsNotificationContent { + return v.value +} + +func (v *NullableScheduledRefundsNotificationContent) Set(val *ScheduledRefundsNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableScheduledRefundsNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableScheduledRefundsNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableScheduledRefundsNotificationContent(val *ScheduledRefundsNotificationContent) *NullableScheduledRefundsNotificationContent { + return &NullableScheduledRefundsNotificationContent{value: val, isSet: true} +} + +func (v NullableScheduledRefundsNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableScheduledRefundsNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_shareholder_contact.go b/src/platformsnotificationevents/model_shareholder_contact.go new file mode 100644 index 000000000..840bffad6 --- /dev/null +++ b/src/platformsnotificationevents/model_shareholder_contact.go @@ -0,0 +1,409 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// ShareholderContact struct for ShareholderContact +type ShareholderContact struct { + Address *ViasAddress `json:"address,omitempty"` + // The e-mail address of the contact. + Email *string `json:"email,omitempty"` + // The phone number of the contact provided as a single string. It will be handled as a landline phone. **Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\" + FullPhoneNumber *string `json:"fullPhoneNumber,omitempty"` + Name *ViasName `json:"name,omitempty"` + PersonalData *ViasPersonalData `json:"personalData,omitempty"` + PhoneNumber *ViasPhoneNumber `json:"phoneNumber,omitempty"` + // The unique identifier (UUID) of the Shareholder. >**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.** >**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.** >**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.** >**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.** + ShareholderCode *string `json:"shareholderCode,omitempty"` + // Merchant reference to the Shareholder. + ShareholderReference *string `json:"shareholderReference,omitempty"` + // The URL of the website of the contact. + WebAddress *string `json:"webAddress,omitempty"` +} + +// NewShareholderContact instantiates a new ShareholderContact object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewShareholderContact() *ShareholderContact { + this := ShareholderContact{} + return &this +} + +// NewShareholderContactWithDefaults instantiates a new ShareholderContact object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewShareholderContactWithDefaults() *ShareholderContact { + this := ShareholderContact{} + return &this +} + +// GetAddress returns the Address field value if set, zero value otherwise. +func (o *ShareholderContact) GetAddress() ViasAddress { + if o == nil || o.Address == nil { + var ret ViasAddress + return ret + } + return *o.Address +} + +// GetAddressOk returns a tuple with the Address field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ShareholderContact) GetAddressOk() (*ViasAddress, bool) { + if o == nil || o.Address == nil { + return nil, false + } + return o.Address, true +} + +// HasAddress returns a boolean if a field has been set. +func (o *ShareholderContact) HasAddress() bool { + if o != nil && o.Address != nil { + return true + } + + return false +} + +// SetAddress gets a reference to the given ViasAddress and assigns it to the Address field. +func (o *ShareholderContact) SetAddress(v ViasAddress) { + o.Address = &v +} + +// GetEmail returns the Email field value if set, zero value otherwise. +func (o *ShareholderContact) GetEmail() string { + if o == nil || o.Email == nil { + var ret string + return ret + } + return *o.Email +} + +// GetEmailOk returns a tuple with the Email field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ShareholderContact) GetEmailOk() (*string, bool) { + if o == nil || o.Email == nil { + return nil, false + } + return o.Email, true +} + +// HasEmail returns a boolean if a field has been set. +func (o *ShareholderContact) HasEmail() bool { + if o != nil && o.Email != nil { + return true + } + + return false +} + +// SetEmail gets a reference to the given string and assigns it to the Email field. +func (o *ShareholderContact) SetEmail(v string) { + o.Email = &v +} + +// GetFullPhoneNumber returns the FullPhoneNumber field value if set, zero value otherwise. +func (o *ShareholderContact) GetFullPhoneNumber() string { + if o == nil || o.FullPhoneNumber == nil { + var ret string + return ret + } + return *o.FullPhoneNumber +} + +// GetFullPhoneNumberOk returns a tuple with the FullPhoneNumber field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ShareholderContact) GetFullPhoneNumberOk() (*string, bool) { + if o == nil || o.FullPhoneNumber == nil { + return nil, false + } + return o.FullPhoneNumber, true +} + +// HasFullPhoneNumber returns a boolean if a field has been set. +func (o *ShareholderContact) HasFullPhoneNumber() bool { + if o != nil && o.FullPhoneNumber != nil { + return true + } + + return false +} + +// SetFullPhoneNumber gets a reference to the given string and assigns it to the FullPhoneNumber field. +func (o *ShareholderContact) SetFullPhoneNumber(v string) { + o.FullPhoneNumber = &v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *ShareholderContact) GetName() ViasName { + if o == nil || o.Name == nil { + var ret ViasName + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ShareholderContact) GetNameOk() (*ViasName, bool) { + if o == nil || o.Name == nil { + return nil, false + } + return o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *ShareholderContact) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given ViasName and assigns it to the Name field. +func (o *ShareholderContact) SetName(v ViasName) { + o.Name = &v +} + +// GetPersonalData returns the PersonalData field value if set, zero value otherwise. +func (o *ShareholderContact) GetPersonalData() ViasPersonalData { + if o == nil || o.PersonalData == nil { + var ret ViasPersonalData + return ret + } + return *o.PersonalData +} + +// GetPersonalDataOk returns a tuple with the PersonalData field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ShareholderContact) GetPersonalDataOk() (*ViasPersonalData, bool) { + if o == nil || o.PersonalData == nil { + return nil, false + } + return o.PersonalData, true +} + +// HasPersonalData returns a boolean if a field has been set. +func (o *ShareholderContact) HasPersonalData() bool { + if o != nil && o.PersonalData != nil { + return true + } + + return false +} + +// SetPersonalData gets a reference to the given ViasPersonalData and assigns it to the PersonalData field. +func (o *ShareholderContact) SetPersonalData(v ViasPersonalData) { + o.PersonalData = &v +} + +// GetPhoneNumber returns the PhoneNumber field value if set, zero value otherwise. +func (o *ShareholderContact) GetPhoneNumber() ViasPhoneNumber { + if o == nil || o.PhoneNumber == nil { + var ret ViasPhoneNumber + return ret + } + return *o.PhoneNumber +} + +// GetPhoneNumberOk returns a tuple with the PhoneNumber field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ShareholderContact) GetPhoneNumberOk() (*ViasPhoneNumber, bool) { + if o == nil || o.PhoneNumber == nil { + return nil, false + } + return o.PhoneNumber, true +} + +// HasPhoneNumber returns a boolean if a field has been set. +func (o *ShareholderContact) HasPhoneNumber() bool { + if o != nil && o.PhoneNumber != nil { + return true + } + + return false +} + +// SetPhoneNumber gets a reference to the given ViasPhoneNumber and assigns it to the PhoneNumber field. +func (o *ShareholderContact) SetPhoneNumber(v ViasPhoneNumber) { + o.PhoneNumber = &v +} + +// GetShareholderCode returns the ShareholderCode field value if set, zero value otherwise. +func (o *ShareholderContact) GetShareholderCode() string { + if o == nil || o.ShareholderCode == nil { + var ret string + return ret + } + return *o.ShareholderCode +} + +// GetShareholderCodeOk returns a tuple with the ShareholderCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ShareholderContact) GetShareholderCodeOk() (*string, bool) { + if o == nil || o.ShareholderCode == nil { + return nil, false + } + return o.ShareholderCode, true +} + +// HasShareholderCode returns a boolean if a field has been set. +func (o *ShareholderContact) HasShareholderCode() bool { + if o != nil && o.ShareholderCode != nil { + return true + } + + return false +} + +// SetShareholderCode gets a reference to the given string and assigns it to the ShareholderCode field. +func (o *ShareholderContact) SetShareholderCode(v string) { + o.ShareholderCode = &v +} + +// GetShareholderReference returns the ShareholderReference field value if set, zero value otherwise. +func (o *ShareholderContact) GetShareholderReference() string { + if o == nil || o.ShareholderReference == nil { + var ret string + return ret + } + return *o.ShareholderReference +} + +// GetShareholderReferenceOk returns a tuple with the ShareholderReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ShareholderContact) GetShareholderReferenceOk() (*string, bool) { + if o == nil || o.ShareholderReference == nil { + return nil, false + } + return o.ShareholderReference, true +} + +// HasShareholderReference returns a boolean if a field has been set. +func (o *ShareholderContact) HasShareholderReference() bool { + if o != nil && o.ShareholderReference != nil { + return true + } + + return false +} + +// SetShareholderReference gets a reference to the given string and assigns it to the ShareholderReference field. +func (o *ShareholderContact) SetShareholderReference(v string) { + o.ShareholderReference = &v +} + +// GetWebAddress returns the WebAddress field value if set, zero value otherwise. +func (o *ShareholderContact) GetWebAddress() string { + if o == nil || o.WebAddress == nil { + var ret string + return ret + } + return *o.WebAddress +} + +// GetWebAddressOk returns a tuple with the WebAddress field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ShareholderContact) GetWebAddressOk() (*string, bool) { + if o == nil || o.WebAddress == nil { + return nil, false + } + return o.WebAddress, true +} + +// HasWebAddress returns a boolean if a field has been set. +func (o *ShareholderContact) HasWebAddress() bool { + if o != nil && o.WebAddress != nil { + return true + } + + return false +} + +// SetWebAddress gets a reference to the given string and assigns it to the WebAddress field. +func (o *ShareholderContact) SetWebAddress(v string) { + o.WebAddress = &v +} + +func (o ShareholderContact) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Address != nil { + toSerialize["address"] = o.Address + } + if o.Email != nil { + toSerialize["email"] = o.Email + } + if o.FullPhoneNumber != nil { + toSerialize["fullPhoneNumber"] = o.FullPhoneNumber + } + if o.Name != nil { + toSerialize["name"] = o.Name + } + if o.PersonalData != nil { + toSerialize["personalData"] = o.PersonalData + } + if o.PhoneNumber != nil { + toSerialize["phoneNumber"] = o.PhoneNumber + } + if o.ShareholderCode != nil { + toSerialize["shareholderCode"] = o.ShareholderCode + } + if o.ShareholderReference != nil { + toSerialize["shareholderReference"] = o.ShareholderReference + } + if o.WebAddress != nil { + toSerialize["webAddress"] = o.WebAddress + } + return json.Marshal(toSerialize) +} + +type NullableShareholderContact struct { + value *ShareholderContact + isSet bool +} + +func (v NullableShareholderContact) Get() *ShareholderContact { + return v.value +} + +func (v *NullableShareholderContact) Set(val *ShareholderContact) { + v.value = val + v.isSet = true +} + +func (v NullableShareholderContact) IsSet() bool { + return v.isSet +} + +func (v *NullableShareholderContact) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableShareholderContact(val *ShareholderContact) *NullableShareholderContact { + return &NullableShareholderContact{value: val, isSet: true} +} + +func (v NullableShareholderContact) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableShareholderContact) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_transaction.go b/src/platformsnotificationevents/model_transaction.go new file mode 100644 index 000000000..67fb23c64 --- /dev/null +++ b/src/platformsnotificationevents/model_transaction.go @@ -0,0 +1,671 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// Transaction struct for Transaction +type Transaction struct { + Amount *Amount `json:"amount,omitempty"` + BankAccountDetail *BankAccountDetail `json:"bankAccountDetail,omitempty"` + // The merchant reference of a related capture. + CaptureMerchantReference *string `json:"captureMerchantReference,omitempty"` + // The psp reference of a related capture. + CapturePspReference *string `json:"capturePspReference,omitempty"` + // The date on which the transaction was performed. + CreationDate *time.Time `json:"creationDate,omitempty"` + // A description of the transaction. + Description *string `json:"description,omitempty"` + // The code of the account to which funds were credited during an outgoing fund transfer. + DestinationAccountCode *string `json:"destinationAccountCode,omitempty"` + // The psp reference of the related dispute. + DisputePspReference *string `json:"disputePspReference,omitempty"` + // The reason code of a dispute. + DisputeReasonCode *string `json:"disputeReasonCode,omitempty"` + // The merchant reference of a transaction. + MerchantReference *string `json:"merchantReference,omitempty"` + // The psp reference of the related authorisation or transfer. + PaymentPspReference *string `json:"paymentPspReference,omitempty"` + // The psp reference of the related payout. + PayoutPspReference *string `json:"payoutPspReference,omitempty"` + // The psp reference of a transaction. + PspReference *string `json:"pspReference,omitempty"` + // The code of the account from which funds were debited during an incoming fund transfer. + SourceAccountCode *string `json:"sourceAccountCode,omitempty"` + // The status of the transaction. >Permitted values: `PendingCredit`, `CreditFailed`, `CreditClosed`, `CreditSuspended`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`. + TransactionStatus *string `json:"transactionStatus,omitempty"` + // The transfer code of the transaction. + TransferCode *string `json:"transferCode,omitempty"` +} + +// NewTransaction instantiates a new Transaction object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewTransaction() *Transaction { + this := Transaction{} + return &this +} + +// NewTransactionWithDefaults instantiates a new Transaction object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewTransactionWithDefaults() *Transaction { + this := Transaction{} + return &this +} + +// GetAmount returns the Amount field value if set, zero value otherwise. +func (o *Transaction) GetAmount() Amount { + if o == nil || o.Amount == nil { + var ret Amount + return ret + } + return *o.Amount +} + +// GetAmountOk returns a tuple with the Amount field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetAmountOk() (*Amount, bool) { + if o == nil || o.Amount == nil { + return nil, false + } + return o.Amount, true +} + +// HasAmount returns a boolean if a field has been set. +func (o *Transaction) HasAmount() bool { + if o != nil && o.Amount != nil { + return true + } + + return false +} + +// SetAmount gets a reference to the given Amount and assigns it to the Amount field. +func (o *Transaction) SetAmount(v Amount) { + o.Amount = &v +} + +// GetBankAccountDetail returns the BankAccountDetail field value if set, zero value otherwise. +func (o *Transaction) GetBankAccountDetail() BankAccountDetail { + if o == nil || o.BankAccountDetail == nil { + var ret BankAccountDetail + return ret + } + return *o.BankAccountDetail +} + +// GetBankAccountDetailOk returns a tuple with the BankAccountDetail field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetBankAccountDetailOk() (*BankAccountDetail, bool) { + if o == nil || o.BankAccountDetail == nil { + return nil, false + } + return o.BankAccountDetail, true +} + +// HasBankAccountDetail returns a boolean if a field has been set. +func (o *Transaction) HasBankAccountDetail() bool { + if o != nil && o.BankAccountDetail != nil { + return true + } + + return false +} + +// SetBankAccountDetail gets a reference to the given BankAccountDetail and assigns it to the BankAccountDetail field. +func (o *Transaction) SetBankAccountDetail(v BankAccountDetail) { + o.BankAccountDetail = &v +} + +// GetCaptureMerchantReference returns the CaptureMerchantReference field value if set, zero value otherwise. +func (o *Transaction) GetCaptureMerchantReference() string { + if o == nil || o.CaptureMerchantReference == nil { + var ret string + return ret + } + return *o.CaptureMerchantReference +} + +// GetCaptureMerchantReferenceOk returns a tuple with the CaptureMerchantReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetCaptureMerchantReferenceOk() (*string, bool) { + if o == nil || o.CaptureMerchantReference == nil { + return nil, false + } + return o.CaptureMerchantReference, true +} + +// HasCaptureMerchantReference returns a boolean if a field has been set. +func (o *Transaction) HasCaptureMerchantReference() bool { + if o != nil && o.CaptureMerchantReference != nil { + return true + } + + return false +} + +// SetCaptureMerchantReference gets a reference to the given string and assigns it to the CaptureMerchantReference field. +func (o *Transaction) SetCaptureMerchantReference(v string) { + o.CaptureMerchantReference = &v +} + +// GetCapturePspReference returns the CapturePspReference field value if set, zero value otherwise. +func (o *Transaction) GetCapturePspReference() string { + if o == nil || o.CapturePspReference == nil { + var ret string + return ret + } + return *o.CapturePspReference +} + +// GetCapturePspReferenceOk returns a tuple with the CapturePspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetCapturePspReferenceOk() (*string, bool) { + if o == nil || o.CapturePspReference == nil { + return nil, false + } + return o.CapturePspReference, true +} + +// HasCapturePspReference returns a boolean if a field has been set. +func (o *Transaction) HasCapturePspReference() bool { + if o != nil && o.CapturePspReference != nil { + return true + } + + return false +} + +// SetCapturePspReference gets a reference to the given string and assigns it to the CapturePspReference field. +func (o *Transaction) SetCapturePspReference(v string) { + o.CapturePspReference = &v +} + +// GetCreationDate returns the CreationDate field value if set, zero value otherwise. +func (o *Transaction) GetCreationDate() time.Time { + if o == nil || o.CreationDate == nil { + var ret time.Time + return ret + } + return *o.CreationDate +} + +// GetCreationDateOk returns a tuple with the CreationDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetCreationDateOk() (*time.Time, bool) { + if o == nil || o.CreationDate == nil { + return nil, false + } + return o.CreationDate, true +} + +// HasCreationDate returns a boolean if a field has been set. +func (o *Transaction) HasCreationDate() bool { + if o != nil && o.CreationDate != nil { + return true + } + + return false +} + +// SetCreationDate gets a reference to the given time.Time and assigns it to the CreationDate field. +func (o *Transaction) SetCreationDate(v time.Time) { + o.CreationDate = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *Transaction) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetDescriptionOk() (*string, bool) { + if o == nil || o.Description == nil { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *Transaction) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *Transaction) SetDescription(v string) { + o.Description = &v +} + +// GetDestinationAccountCode returns the DestinationAccountCode field value if set, zero value otherwise. +func (o *Transaction) GetDestinationAccountCode() string { + if o == nil || o.DestinationAccountCode == nil { + var ret string + return ret + } + return *o.DestinationAccountCode +} + +// GetDestinationAccountCodeOk returns a tuple with the DestinationAccountCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetDestinationAccountCodeOk() (*string, bool) { + if o == nil || o.DestinationAccountCode == nil { + return nil, false + } + return o.DestinationAccountCode, true +} + +// HasDestinationAccountCode returns a boolean if a field has been set. +func (o *Transaction) HasDestinationAccountCode() bool { + if o != nil && o.DestinationAccountCode != nil { + return true + } + + return false +} + +// SetDestinationAccountCode gets a reference to the given string and assigns it to the DestinationAccountCode field. +func (o *Transaction) SetDestinationAccountCode(v string) { + o.DestinationAccountCode = &v +} + +// GetDisputePspReference returns the DisputePspReference field value if set, zero value otherwise. +func (o *Transaction) GetDisputePspReference() string { + if o == nil || o.DisputePspReference == nil { + var ret string + return ret + } + return *o.DisputePspReference +} + +// GetDisputePspReferenceOk returns a tuple with the DisputePspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetDisputePspReferenceOk() (*string, bool) { + if o == nil || o.DisputePspReference == nil { + return nil, false + } + return o.DisputePspReference, true +} + +// HasDisputePspReference returns a boolean if a field has been set. +func (o *Transaction) HasDisputePspReference() bool { + if o != nil && o.DisputePspReference != nil { + return true + } + + return false +} + +// SetDisputePspReference gets a reference to the given string and assigns it to the DisputePspReference field. +func (o *Transaction) SetDisputePspReference(v string) { + o.DisputePspReference = &v +} + +// GetDisputeReasonCode returns the DisputeReasonCode field value if set, zero value otherwise. +func (o *Transaction) GetDisputeReasonCode() string { + if o == nil || o.DisputeReasonCode == nil { + var ret string + return ret + } + return *o.DisputeReasonCode +} + +// GetDisputeReasonCodeOk returns a tuple with the DisputeReasonCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetDisputeReasonCodeOk() (*string, bool) { + if o == nil || o.DisputeReasonCode == nil { + return nil, false + } + return o.DisputeReasonCode, true +} + +// HasDisputeReasonCode returns a boolean if a field has been set. +func (o *Transaction) HasDisputeReasonCode() bool { + if o != nil && o.DisputeReasonCode != nil { + return true + } + + return false +} + +// SetDisputeReasonCode gets a reference to the given string and assigns it to the DisputeReasonCode field. +func (o *Transaction) SetDisputeReasonCode(v string) { + o.DisputeReasonCode = &v +} + +// GetMerchantReference returns the MerchantReference field value if set, zero value otherwise. +func (o *Transaction) GetMerchantReference() string { + if o == nil || o.MerchantReference == nil { + var ret string + return ret + } + return *o.MerchantReference +} + +// GetMerchantReferenceOk returns a tuple with the MerchantReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetMerchantReferenceOk() (*string, bool) { + if o == nil || o.MerchantReference == nil { + return nil, false + } + return o.MerchantReference, true +} + +// HasMerchantReference returns a boolean if a field has been set. +func (o *Transaction) HasMerchantReference() bool { + if o != nil && o.MerchantReference != nil { + return true + } + + return false +} + +// SetMerchantReference gets a reference to the given string and assigns it to the MerchantReference field. +func (o *Transaction) SetMerchantReference(v string) { + o.MerchantReference = &v +} + +// GetPaymentPspReference returns the PaymentPspReference field value if set, zero value otherwise. +func (o *Transaction) GetPaymentPspReference() string { + if o == nil || o.PaymentPspReference == nil { + var ret string + return ret + } + return *o.PaymentPspReference +} + +// GetPaymentPspReferenceOk returns a tuple with the PaymentPspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetPaymentPspReferenceOk() (*string, bool) { + if o == nil || o.PaymentPspReference == nil { + return nil, false + } + return o.PaymentPspReference, true +} + +// HasPaymentPspReference returns a boolean if a field has been set. +func (o *Transaction) HasPaymentPspReference() bool { + if o != nil && o.PaymentPspReference != nil { + return true + } + + return false +} + +// SetPaymentPspReference gets a reference to the given string and assigns it to the PaymentPspReference field. +func (o *Transaction) SetPaymentPspReference(v string) { + o.PaymentPspReference = &v +} + +// GetPayoutPspReference returns the PayoutPspReference field value if set, zero value otherwise. +func (o *Transaction) GetPayoutPspReference() string { + if o == nil || o.PayoutPspReference == nil { + var ret string + return ret + } + return *o.PayoutPspReference +} + +// GetPayoutPspReferenceOk returns a tuple with the PayoutPspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetPayoutPspReferenceOk() (*string, bool) { + if o == nil || o.PayoutPspReference == nil { + return nil, false + } + return o.PayoutPspReference, true +} + +// HasPayoutPspReference returns a boolean if a field has been set. +func (o *Transaction) HasPayoutPspReference() bool { + if o != nil && o.PayoutPspReference != nil { + return true + } + + return false +} + +// SetPayoutPspReference gets a reference to the given string and assigns it to the PayoutPspReference field. +func (o *Transaction) SetPayoutPspReference(v string) { + o.PayoutPspReference = &v +} + +// GetPspReference returns the PspReference field value if set, zero value otherwise. +func (o *Transaction) GetPspReference() string { + if o == nil || o.PspReference == nil { + var ret string + return ret + } + return *o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetPspReferenceOk() (*string, bool) { + if o == nil || o.PspReference == nil { + return nil, false + } + return o.PspReference, true +} + +// HasPspReference returns a boolean if a field has been set. +func (o *Transaction) HasPspReference() bool { + if o != nil && o.PspReference != nil { + return true + } + + return false +} + +// SetPspReference gets a reference to the given string and assigns it to the PspReference field. +func (o *Transaction) SetPspReference(v string) { + o.PspReference = &v +} + +// GetSourceAccountCode returns the SourceAccountCode field value if set, zero value otherwise. +func (o *Transaction) GetSourceAccountCode() string { + if o == nil || o.SourceAccountCode == nil { + var ret string + return ret + } + return *o.SourceAccountCode +} + +// GetSourceAccountCodeOk returns a tuple with the SourceAccountCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetSourceAccountCodeOk() (*string, bool) { + if o == nil || o.SourceAccountCode == nil { + return nil, false + } + return o.SourceAccountCode, true +} + +// HasSourceAccountCode returns a boolean if a field has been set. +func (o *Transaction) HasSourceAccountCode() bool { + if o != nil && o.SourceAccountCode != nil { + return true + } + + return false +} + +// SetSourceAccountCode gets a reference to the given string and assigns it to the SourceAccountCode field. +func (o *Transaction) SetSourceAccountCode(v string) { + o.SourceAccountCode = &v +} + +// GetTransactionStatus returns the TransactionStatus field value if set, zero value otherwise. +func (o *Transaction) GetTransactionStatus() string { + if o == nil || o.TransactionStatus == nil { + var ret string + return ret + } + return *o.TransactionStatus +} + +// GetTransactionStatusOk returns a tuple with the TransactionStatus field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetTransactionStatusOk() (*string, bool) { + if o == nil || o.TransactionStatus == nil { + return nil, false + } + return o.TransactionStatus, true +} + +// HasTransactionStatus returns a boolean if a field has been set. +func (o *Transaction) HasTransactionStatus() bool { + if o != nil && o.TransactionStatus != nil { + return true + } + + return false +} + +// SetTransactionStatus gets a reference to the given string and assigns it to the TransactionStatus field. +func (o *Transaction) SetTransactionStatus(v string) { + o.TransactionStatus = &v +} + +// GetTransferCode returns the TransferCode field value if set, zero value otherwise. +func (o *Transaction) GetTransferCode() string { + if o == nil || o.TransferCode == nil { + var ret string + return ret + } + return *o.TransferCode +} + +// GetTransferCodeOk returns a tuple with the TransferCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *Transaction) GetTransferCodeOk() (*string, bool) { + if o == nil || o.TransferCode == nil { + return nil, false + } + return o.TransferCode, true +} + +// HasTransferCode returns a boolean if a field has been set. +func (o *Transaction) HasTransferCode() bool { + if o != nil && o.TransferCode != nil { + return true + } + + return false +} + +// SetTransferCode gets a reference to the given string and assigns it to the TransferCode field. +func (o *Transaction) SetTransferCode(v string) { + o.TransferCode = &v +} + +func (o Transaction) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.Amount != nil { + toSerialize["amount"] = o.Amount + } + if o.BankAccountDetail != nil { + toSerialize["bankAccountDetail"] = o.BankAccountDetail + } + if o.CaptureMerchantReference != nil { + toSerialize["captureMerchantReference"] = o.CaptureMerchantReference + } + if o.CapturePspReference != nil { + toSerialize["capturePspReference"] = o.CapturePspReference + } + if o.CreationDate != nil { + toSerialize["creationDate"] = o.CreationDate + } + if o.Description != nil { + toSerialize["description"] = o.Description + } + if o.DestinationAccountCode != nil { + toSerialize["destinationAccountCode"] = o.DestinationAccountCode + } + if o.DisputePspReference != nil { + toSerialize["disputePspReference"] = o.DisputePspReference + } + if o.DisputeReasonCode != nil { + toSerialize["disputeReasonCode"] = o.DisputeReasonCode + } + if o.MerchantReference != nil { + toSerialize["merchantReference"] = o.MerchantReference + } + if o.PaymentPspReference != nil { + toSerialize["paymentPspReference"] = o.PaymentPspReference + } + if o.PayoutPspReference != nil { + toSerialize["payoutPspReference"] = o.PayoutPspReference + } + if o.PspReference != nil { + toSerialize["pspReference"] = o.PspReference + } + if o.SourceAccountCode != nil { + toSerialize["sourceAccountCode"] = o.SourceAccountCode + } + if o.TransactionStatus != nil { + toSerialize["transactionStatus"] = o.TransactionStatus + } + if o.TransferCode != nil { + toSerialize["transferCode"] = o.TransferCode + } + return json.Marshal(toSerialize) +} + +type NullableTransaction struct { + value *Transaction + isSet bool +} + +func (v NullableTransaction) Get() *Transaction { + return v.value +} + +func (v *NullableTransaction) Set(val *Transaction) { + v.value = val + v.isSet = true +} + +func (v NullableTransaction) IsSet() bool { + return v.isSet +} + +func (v *NullableTransaction) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableTransaction(val *Transaction) *NullableTransaction { + return &NullableTransaction{value: val, isSet: true} +} + +func (v NullableTransaction) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableTransaction) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_transfer_funds_notification.go b/src/platformsnotificationevents/model_transfer_funds_notification.go new file mode 100644 index 000000000..42f52c8fe --- /dev/null +++ b/src/platformsnotificationevents/model_transfer_funds_notification.go @@ -0,0 +1,296 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" + "time" +) + +// TransferFundsNotification struct for TransferFundsNotification +type TransferFundsNotification struct { + Content TransferFundsNotificationContent `json:"content"` + Error *NotificationErrorContainer `json:"error,omitempty"` + // The date and time when an event has been completed. + EventDate time.Time `json:"eventDate"` + // The event type of the notification. + EventType string `json:"eventType"` + // The user or process that has triggered the notification. + ExecutingUserKey string `json:"executingUserKey"` + // Indicates whether the notification originated from the live environment or the test environment. If true, the notification originated from the live environment. If false, the notification originated from the test environment. + Live bool `json:"live"` + // The PSP reference of the request from which the notification originates. + PspReference string `json:"pspReference"` +} + +// NewTransferFundsNotification instantiates a new TransferFundsNotification object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewTransferFundsNotification(content TransferFundsNotificationContent, eventDate time.Time, eventType string, executingUserKey string, live bool, pspReference string, ) *TransferFundsNotification { + this := TransferFundsNotification{} + this.Content = content + this.EventDate = eventDate + this.EventType = eventType + this.ExecutingUserKey = executingUserKey + this.Live = live + this.PspReference = pspReference + return &this +} + +// NewTransferFundsNotificationWithDefaults instantiates a new TransferFundsNotification object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewTransferFundsNotificationWithDefaults() *TransferFundsNotification { + this := TransferFundsNotification{} + return &this +} + +// GetContent returns the Content field value +func (o *TransferFundsNotification) GetContent() TransferFundsNotificationContent { + if o == nil { + var ret TransferFundsNotificationContent + return ret + } + + return o.Content +} + +// GetContentOk returns a tuple with the Content field value +// and a boolean to check if the value has been set. +func (o *TransferFundsNotification) GetContentOk() (*TransferFundsNotificationContent, bool) { + if o == nil { + return nil, false + } + return &o.Content, true +} + +// SetContent sets field value +func (o *TransferFundsNotification) SetContent(v TransferFundsNotificationContent) { + o.Content = v +} + +// GetError returns the Error field value if set, zero value otherwise. +func (o *TransferFundsNotification) GetError() NotificationErrorContainer { + if o == nil || o.Error == nil { + var ret NotificationErrorContainer + return ret + } + return *o.Error +} + +// GetErrorOk returns a tuple with the Error field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TransferFundsNotification) GetErrorOk() (*NotificationErrorContainer, bool) { + if o == nil || o.Error == nil { + return nil, false + } + return o.Error, true +} + +// HasError returns a boolean if a field has been set. +func (o *TransferFundsNotification) HasError() bool { + if o != nil && o.Error != nil { + return true + } + + return false +} + +// SetError gets a reference to the given NotificationErrorContainer and assigns it to the Error field. +func (o *TransferFundsNotification) SetError(v NotificationErrorContainer) { + o.Error = &v +} + +// GetEventDate returns the EventDate field value +func (o *TransferFundsNotification) GetEventDate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.EventDate +} + +// GetEventDateOk returns a tuple with the EventDate field value +// and a boolean to check if the value has been set. +func (o *TransferFundsNotification) GetEventDateOk() (*time.Time, bool) { + if o == nil { + return nil, false + } + return &o.EventDate, true +} + +// SetEventDate sets field value +func (o *TransferFundsNotification) SetEventDate(v time.Time) { + o.EventDate = v +} + +// GetEventType returns the EventType field value +func (o *TransferFundsNotification) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// GetEventTypeOk returns a tuple with the EventType field value +// and a boolean to check if the value has been set. +func (o *TransferFundsNotification) GetEventTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.EventType, true +} + +// SetEventType sets field value +func (o *TransferFundsNotification) SetEventType(v string) { + o.EventType = v +} + +// GetExecutingUserKey returns the ExecutingUserKey field value +func (o *TransferFundsNotification) GetExecutingUserKey() string { + if o == nil { + var ret string + return ret + } + + return o.ExecutingUserKey +} + +// GetExecutingUserKeyOk returns a tuple with the ExecutingUserKey field value +// and a boolean to check if the value has been set. +func (o *TransferFundsNotification) GetExecutingUserKeyOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.ExecutingUserKey, true +} + +// SetExecutingUserKey sets field value +func (o *TransferFundsNotification) SetExecutingUserKey(v string) { + o.ExecutingUserKey = v +} + +// GetLive returns the Live field value +func (o *TransferFundsNotification) GetLive() bool { + if o == nil { + var ret bool + return ret + } + + return o.Live +} + +// GetLiveOk returns a tuple with the Live field value +// and a boolean to check if the value has been set. +func (o *TransferFundsNotification) GetLiveOk() (*bool, bool) { + if o == nil { + return nil, false + } + return &o.Live, true +} + +// SetLive sets field value +func (o *TransferFundsNotification) SetLive(v bool) { + o.Live = v +} + +// GetPspReference returns the PspReference field value +func (o *TransferFundsNotification) GetPspReference() string { + if o == nil { + var ret string + return ret + } + + return o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value +// and a boolean to check if the value has been set. +func (o *TransferFundsNotification) GetPspReferenceOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PspReference, true +} + +// SetPspReference sets field value +func (o *TransferFundsNotification) SetPspReference(v string) { + o.PspReference = v +} + +func (o TransferFundsNotification) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["content"] = o.Content + } + if o.Error != nil { + toSerialize["error"] = o.Error + } + if true { + toSerialize["eventDate"] = o.EventDate + } + if true { + toSerialize["eventType"] = o.EventType + } + if true { + toSerialize["executingUserKey"] = o.ExecutingUserKey + } + if true { + toSerialize["live"] = o.Live + } + if true { + toSerialize["pspReference"] = o.PspReference + } + return json.Marshal(toSerialize) +} + +type NullableTransferFundsNotification struct { + value *TransferFundsNotification + isSet bool +} + +func (v NullableTransferFundsNotification) Get() *TransferFundsNotification { + return v.value +} + +func (v *NullableTransferFundsNotification) Set(val *TransferFundsNotification) { + v.value = val + v.isSet = true +} + +func (v NullableTransferFundsNotification) IsSet() bool { + return v.isSet +} + +func (v *NullableTransferFundsNotification) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableTransferFundsNotification(val *TransferFundsNotification) *NullableTransferFundsNotification { + return &NullableTransferFundsNotification{value: val, isSet: true} +} + +func (v NullableTransferFundsNotification) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableTransferFundsNotification) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_transfer_funds_notification_content.go b/src/platformsnotificationevents/model_transfer_funds_notification_content.go new file mode 100644 index 000000000..6f17f5fa5 --- /dev/null +++ b/src/platformsnotificationevents/model_transfer_funds_notification_content.go @@ -0,0 +1,309 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// TransferFundsNotificationContent struct for TransferFundsNotificationContent +type TransferFundsNotificationContent struct { + Amount Amount `json:"amount"` + // The code of the Account to which funds were credited. + DestinationAccountCode string `json:"destinationAccountCode"` + // Invalid fields list. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + // The reference provided by the merchant. + MerchantReference *string `json:"merchantReference,omitempty"` + // The code of the Account from which funds were debited. + SourceAccountCode string `json:"sourceAccountCode"` + Status *OperationStatus `json:"status,omitempty"` + // The transfer code. + TransferCode string `json:"transferCode"` +} + +// NewTransferFundsNotificationContent instantiates a new TransferFundsNotificationContent object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewTransferFundsNotificationContent(amount Amount, destinationAccountCode string, sourceAccountCode string, transferCode string, ) *TransferFundsNotificationContent { + this := TransferFundsNotificationContent{} + this.Amount = amount + this.DestinationAccountCode = destinationAccountCode + this.SourceAccountCode = sourceAccountCode + this.TransferCode = transferCode + return &this +} + +// NewTransferFundsNotificationContentWithDefaults instantiates a new TransferFundsNotificationContent object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewTransferFundsNotificationContentWithDefaults() *TransferFundsNotificationContent { + this := TransferFundsNotificationContent{} + return &this +} + +// GetAmount returns the Amount field value +func (o *TransferFundsNotificationContent) GetAmount() Amount { + if o == nil { + var ret Amount + return ret + } + + return o.Amount +} + +// GetAmountOk returns a tuple with the Amount field value +// and a boolean to check if the value has been set. +func (o *TransferFundsNotificationContent) GetAmountOk() (*Amount, bool) { + if o == nil { + return nil, false + } + return &o.Amount, true +} + +// SetAmount sets field value +func (o *TransferFundsNotificationContent) SetAmount(v Amount) { + o.Amount = v +} + +// GetDestinationAccountCode returns the DestinationAccountCode field value +func (o *TransferFundsNotificationContent) GetDestinationAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.DestinationAccountCode +} + +// GetDestinationAccountCodeOk returns a tuple with the DestinationAccountCode field value +// and a boolean to check if the value has been set. +func (o *TransferFundsNotificationContent) GetDestinationAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.DestinationAccountCode, true +} + +// SetDestinationAccountCode sets field value +func (o *TransferFundsNotificationContent) SetDestinationAccountCode(v string) { + o.DestinationAccountCode = v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *TransferFundsNotificationContent) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TransferFundsNotificationContent) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *TransferFundsNotificationContent) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *TransferFundsNotificationContent) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetMerchantReference returns the MerchantReference field value if set, zero value otherwise. +func (o *TransferFundsNotificationContent) GetMerchantReference() string { + if o == nil || o.MerchantReference == nil { + var ret string + return ret + } + return *o.MerchantReference +} + +// GetMerchantReferenceOk returns a tuple with the MerchantReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TransferFundsNotificationContent) GetMerchantReferenceOk() (*string, bool) { + if o == nil || o.MerchantReference == nil { + return nil, false + } + return o.MerchantReference, true +} + +// HasMerchantReference returns a boolean if a field has been set. +func (o *TransferFundsNotificationContent) HasMerchantReference() bool { + if o != nil && o.MerchantReference != nil { + return true + } + + return false +} + +// SetMerchantReference gets a reference to the given string and assigns it to the MerchantReference field. +func (o *TransferFundsNotificationContent) SetMerchantReference(v string) { + o.MerchantReference = &v +} + +// GetSourceAccountCode returns the SourceAccountCode field value +func (o *TransferFundsNotificationContent) GetSourceAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.SourceAccountCode +} + +// GetSourceAccountCodeOk returns a tuple with the SourceAccountCode field value +// and a boolean to check if the value has been set. +func (o *TransferFundsNotificationContent) GetSourceAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.SourceAccountCode, true +} + +// SetSourceAccountCode sets field value +func (o *TransferFundsNotificationContent) SetSourceAccountCode(v string) { + o.SourceAccountCode = v +} + +// GetStatus returns the Status field value if set, zero value otherwise. +func (o *TransferFundsNotificationContent) GetStatus() OperationStatus { + if o == nil || o.Status == nil { + var ret OperationStatus + return ret + } + return *o.Status +} + +// GetStatusOk returns a tuple with the Status field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *TransferFundsNotificationContent) GetStatusOk() (*OperationStatus, bool) { + if o == nil || o.Status == nil { + return nil, false + } + return o.Status, true +} + +// HasStatus returns a boolean if a field has been set. +func (o *TransferFundsNotificationContent) HasStatus() bool { + if o != nil && o.Status != nil { + return true + } + + return false +} + +// SetStatus gets a reference to the given OperationStatus and assigns it to the Status field. +func (o *TransferFundsNotificationContent) SetStatus(v OperationStatus) { + o.Status = &v +} + +// GetTransferCode returns the TransferCode field value +func (o *TransferFundsNotificationContent) GetTransferCode() string { + if o == nil { + var ret string + return ret + } + + return o.TransferCode +} + +// GetTransferCodeOk returns a tuple with the TransferCode field value +// and a boolean to check if the value has been set. +func (o *TransferFundsNotificationContent) GetTransferCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.TransferCode, true +} + +// SetTransferCode sets field value +func (o *TransferFundsNotificationContent) SetTransferCode(v string) { + o.TransferCode = v +} + +func (o TransferFundsNotificationContent) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["amount"] = o.Amount + } + if true { + toSerialize["destinationAccountCode"] = o.DestinationAccountCode + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if o.MerchantReference != nil { + toSerialize["merchantReference"] = o.MerchantReference + } + if true { + toSerialize["sourceAccountCode"] = o.SourceAccountCode + } + if o.Status != nil { + toSerialize["status"] = o.Status + } + if true { + toSerialize["transferCode"] = o.TransferCode + } + return json.Marshal(toSerialize) +} + +type NullableTransferFundsNotificationContent struct { + value *TransferFundsNotificationContent + isSet bool +} + +func (v NullableTransferFundsNotificationContent) Get() *TransferFundsNotificationContent { + return v.value +} + +func (v *NullableTransferFundsNotificationContent) Set(val *TransferFundsNotificationContent) { + v.value = val + v.isSet = true +} + +func (v NullableTransferFundsNotificationContent) IsSet() bool { + return v.isSet +} + +func (v *NullableTransferFundsNotificationContent) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableTransferFundsNotificationContent(val *TransferFundsNotificationContent) *NullableTransferFundsNotificationContent { + return &NullableTransferFundsNotificationContent{value: val, isSet: true} +} + +func (v NullableTransferFundsNotificationContent) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableTransferFundsNotificationContent) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_update_account_holder_response.go b/src/platformsnotificationevents/model_update_account_holder_response.go new file mode 100644 index 000000000..78fcbb680 --- /dev/null +++ b/src/platformsnotificationevents/model_update_account_holder_response.go @@ -0,0 +1,463 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// UpdateAccountHolderResponse struct for UpdateAccountHolderResponse +type UpdateAccountHolderResponse struct { + // The code of the account holder. + AccountHolderCode *string `json:"accountHolderCode,omitempty"` + AccountHolderDetails *AccountHolderDetails `json:"accountHolderDetails,omitempty"` + AccountHolderStatus AccountHolderStatus `json:"accountHolderStatus"` + // The description of the account holder. + Description *string `json:"description,omitempty"` + // in case the account holder has not been updated, contains account holder fields, that did not pass the validation. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + // The legal entity of the account holder. + LegalEntity string `json:"legalEntity"` + // The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. + PrimaryCurrency *string `json:"primaryCurrency,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"` + Verification KYCVerificationResult `json:"verification"` + // The identifier of the profile that applies to this entity. + VerificationProfile *string `json:"verificationProfile,omitempty"` +} + +// NewUpdateAccountHolderResponse instantiates a new UpdateAccountHolderResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewUpdateAccountHolderResponse(accountHolderStatus AccountHolderStatus, legalEntity string, verification KYCVerificationResult, ) *UpdateAccountHolderResponse { + this := UpdateAccountHolderResponse{} + this.AccountHolderStatus = accountHolderStatus + this.LegalEntity = legalEntity + this.Verification = verification + return &this +} + +// NewUpdateAccountHolderResponseWithDefaults instantiates a new UpdateAccountHolderResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewUpdateAccountHolderResponseWithDefaults() *UpdateAccountHolderResponse { + this := UpdateAccountHolderResponse{} + return &this +} + +// GetAccountHolderCode returns the AccountHolderCode field value if set, zero value otherwise. +func (o *UpdateAccountHolderResponse) GetAccountHolderCode() string { + if o == nil || o.AccountHolderCode == nil { + var ret string + return ret + } + return *o.AccountHolderCode +} + +// GetAccountHolderCodeOk returns a tuple with the AccountHolderCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetAccountHolderCodeOk() (*string, bool) { + if o == nil || o.AccountHolderCode == nil { + return nil, false + } + return o.AccountHolderCode, true +} + +// HasAccountHolderCode returns a boolean if a field has been set. +func (o *UpdateAccountHolderResponse) HasAccountHolderCode() bool { + if o != nil && o.AccountHolderCode != nil { + return true + } + + return false +} + +// SetAccountHolderCode gets a reference to the given string and assigns it to the AccountHolderCode field. +func (o *UpdateAccountHolderResponse) SetAccountHolderCode(v string) { + o.AccountHolderCode = &v +} + +// GetAccountHolderDetails returns the AccountHolderDetails field value if set, zero value otherwise. +func (o *UpdateAccountHolderResponse) GetAccountHolderDetails() AccountHolderDetails { + if o == nil || o.AccountHolderDetails == nil { + var ret AccountHolderDetails + return ret + } + return *o.AccountHolderDetails +} + +// GetAccountHolderDetailsOk returns a tuple with the AccountHolderDetails field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetAccountHolderDetailsOk() (*AccountHolderDetails, bool) { + if o == nil || o.AccountHolderDetails == nil { + return nil, false + } + return o.AccountHolderDetails, true +} + +// HasAccountHolderDetails returns a boolean if a field has been set. +func (o *UpdateAccountHolderResponse) HasAccountHolderDetails() bool { + if o != nil && o.AccountHolderDetails != nil { + return true + } + + return false +} + +// SetAccountHolderDetails gets a reference to the given AccountHolderDetails and assigns it to the AccountHolderDetails field. +func (o *UpdateAccountHolderResponse) SetAccountHolderDetails(v AccountHolderDetails) { + o.AccountHolderDetails = &v +} + +// GetAccountHolderStatus returns the AccountHolderStatus field value +func (o *UpdateAccountHolderResponse) GetAccountHolderStatus() AccountHolderStatus { + if o == nil { + var ret AccountHolderStatus + return ret + } + + return o.AccountHolderStatus +} + +// GetAccountHolderStatusOk returns a tuple with the AccountHolderStatus field value +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetAccountHolderStatusOk() (*AccountHolderStatus, bool) { + if o == nil { + return nil, false + } + return &o.AccountHolderStatus, true +} + +// SetAccountHolderStatus sets field value +func (o *UpdateAccountHolderResponse) SetAccountHolderStatus(v AccountHolderStatus) { + o.AccountHolderStatus = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *UpdateAccountHolderResponse) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetDescriptionOk() (*string, bool) { + if o == nil || o.Description == nil { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *UpdateAccountHolderResponse) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *UpdateAccountHolderResponse) SetDescription(v string) { + o.Description = &v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *UpdateAccountHolderResponse) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *UpdateAccountHolderResponse) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *UpdateAccountHolderResponse) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetLegalEntity returns the LegalEntity field value +func (o *UpdateAccountHolderResponse) GetLegalEntity() string { + if o == nil { + var ret string + return ret + } + + return o.LegalEntity +} + +// GetLegalEntityOk returns a tuple with the LegalEntity field value +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetLegalEntityOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.LegalEntity, true +} + +// SetLegalEntity sets field value +func (o *UpdateAccountHolderResponse) SetLegalEntity(v string) { + o.LegalEntity = v +} + +// GetPrimaryCurrency returns the PrimaryCurrency field value if set, zero value otherwise. +func (o *UpdateAccountHolderResponse) GetPrimaryCurrency() string { + if o == nil || o.PrimaryCurrency == nil { + var ret string + return ret + } + return *o.PrimaryCurrency +} + +// GetPrimaryCurrencyOk returns a tuple with the PrimaryCurrency field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetPrimaryCurrencyOk() (*string, bool) { + if o == nil || o.PrimaryCurrency == nil { + return nil, false + } + return o.PrimaryCurrency, true +} + +// HasPrimaryCurrency returns a boolean if a field has been set. +func (o *UpdateAccountHolderResponse) HasPrimaryCurrency() bool { + if o != nil && o.PrimaryCurrency != nil { + return true + } + + return false +} + +// SetPrimaryCurrency gets a reference to the given string and assigns it to the PrimaryCurrency field. +func (o *UpdateAccountHolderResponse) SetPrimaryCurrency(v string) { + o.PrimaryCurrency = &v +} + +// GetPspReference returns the PspReference field value if set, zero value otherwise. +func (o *UpdateAccountHolderResponse) GetPspReference() string { + if o == nil || o.PspReference == nil { + var ret string + return ret + } + return *o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetPspReferenceOk() (*string, bool) { + if o == nil || o.PspReference == nil { + return nil, false + } + return o.PspReference, true +} + +// HasPspReference returns a boolean if a field has been set. +func (o *UpdateAccountHolderResponse) HasPspReference() bool { + if o != nil && o.PspReference != nil { + return true + } + + return false +} + +// SetPspReference gets a reference to the given string and assigns it to the PspReference field. +func (o *UpdateAccountHolderResponse) SetPspReference(v string) { + o.PspReference = &v +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *UpdateAccountHolderResponse) GetResultCode() string { + if o == nil || o.ResultCode == nil { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetResultCodeOk() (*string, bool) { + if o == nil || o.ResultCode == nil { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *UpdateAccountHolderResponse) HasResultCode() bool { + if o != nil && o.ResultCode != nil { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *UpdateAccountHolderResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +// GetVerification returns the Verification field value +func (o *UpdateAccountHolderResponse) GetVerification() KYCVerificationResult { + if o == nil { + var ret KYCVerificationResult + return ret + } + + return o.Verification +} + +// GetVerificationOk returns a tuple with the Verification field value +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetVerificationOk() (*KYCVerificationResult, bool) { + if o == nil { + return nil, false + } + return &o.Verification, true +} + +// SetVerification sets field value +func (o *UpdateAccountHolderResponse) SetVerification(v KYCVerificationResult) { + o.Verification = v +} + +// GetVerificationProfile returns the VerificationProfile field value if set, zero value otherwise. +func (o *UpdateAccountHolderResponse) GetVerificationProfile() string { + if o == nil || o.VerificationProfile == nil { + var ret string + return ret + } + return *o.VerificationProfile +} + +// GetVerificationProfileOk returns a tuple with the VerificationProfile field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountHolderResponse) GetVerificationProfileOk() (*string, bool) { + if o == nil || o.VerificationProfile == nil { + return nil, false + } + return o.VerificationProfile, true +} + +// HasVerificationProfile returns a boolean if a field has been set. +func (o *UpdateAccountHolderResponse) HasVerificationProfile() bool { + if o != nil && o.VerificationProfile != nil { + return true + } + + return false +} + +// SetVerificationProfile gets a reference to the given string and assigns it to the VerificationProfile field. +func (o *UpdateAccountHolderResponse) SetVerificationProfile(v string) { + o.VerificationProfile = &v +} + +func (o UpdateAccountHolderResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.AccountHolderCode != nil { + toSerialize["accountHolderCode"] = o.AccountHolderCode + } + if o.AccountHolderDetails != nil { + toSerialize["accountHolderDetails"] = o.AccountHolderDetails + } + if true { + toSerialize["accountHolderStatus"] = o.AccountHolderStatus + } + if o.Description != nil { + toSerialize["description"] = o.Description + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if true { + toSerialize["legalEntity"] = o.LegalEntity + } + if o.PrimaryCurrency != nil { + toSerialize["primaryCurrency"] = o.PrimaryCurrency + } + if o.PspReference != nil { + toSerialize["pspReference"] = o.PspReference + } + if o.ResultCode != nil { + toSerialize["resultCode"] = o.ResultCode + } + if true { + toSerialize["verification"] = o.Verification + } + if o.VerificationProfile != nil { + toSerialize["verificationProfile"] = o.VerificationProfile + } + return json.Marshal(toSerialize) +} + +type NullableUpdateAccountHolderResponse struct { + value *UpdateAccountHolderResponse + isSet bool +} + +func (v NullableUpdateAccountHolderResponse) Get() *UpdateAccountHolderResponse { + return v.value +} + +func (v *NullableUpdateAccountHolderResponse) Set(val *UpdateAccountHolderResponse) { + v.value = val + v.isSet = true +} + +func (v NullableUpdateAccountHolderResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableUpdateAccountHolderResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableUpdateAccountHolderResponse(val *UpdateAccountHolderResponse) *NullableUpdateAccountHolderResponse { + return &NullableUpdateAccountHolderResponse{value: val, isSet: true} +} + +func (v NullableUpdateAccountHolderResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableUpdateAccountHolderResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_update_account_response.go b/src/platformsnotificationevents/model_update_account_response.go new file mode 100644 index 000000000..f05d05630 --- /dev/null +++ b/src/platformsnotificationevents/model_update_account_response.go @@ -0,0 +1,441 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// UpdateAccountResponse struct for UpdateAccountResponse +type UpdateAccountResponse struct { + // The code of the account. + AccountCode string `json:"accountCode"` + // The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + BankAccountUUID *string `json:"bankAccountUUID,omitempty"` + // The description of the account. + Description *string `json:"description,omitempty"` + // A list of fields that caused the `/updateAccount` request to fail. + InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"` + Metadata *map[string]string `json:"metadata,omitempty"` + // The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + PayoutMethodCode *string `json:"payoutMethodCode,omitempty"` + PayoutSchedule *PayoutScheduleResponse `json:"payoutSchedule,omitempty"` + // Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + PayoutSpeed *string `json:"payoutSpeed,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"` +} + +// NewUpdateAccountResponse instantiates a new UpdateAccountResponse object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewUpdateAccountResponse(accountCode string, ) *UpdateAccountResponse { + this := UpdateAccountResponse{} + this.AccountCode = accountCode + return &this +} + +// NewUpdateAccountResponseWithDefaults instantiates a new UpdateAccountResponse object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewUpdateAccountResponseWithDefaults() *UpdateAccountResponse { + this := UpdateAccountResponse{} + return &this +} + +// GetAccountCode returns the AccountCode field value +func (o *UpdateAccountResponse) GetAccountCode() string { + if o == nil { + var ret string + return ret + } + + return o.AccountCode +} + +// GetAccountCodeOk returns a tuple with the AccountCode field value +// and a boolean to check if the value has been set. +func (o *UpdateAccountResponse) GetAccountCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.AccountCode, true +} + +// SetAccountCode sets field value +func (o *UpdateAccountResponse) SetAccountCode(v string) { + o.AccountCode = v +} + +// GetBankAccountUUID returns the BankAccountUUID field value if set, zero value otherwise. +func (o *UpdateAccountResponse) GetBankAccountUUID() string { + if o == nil || o.BankAccountUUID == nil { + var ret string + return ret + } + return *o.BankAccountUUID +} + +// GetBankAccountUUIDOk returns a tuple with the BankAccountUUID field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountResponse) GetBankAccountUUIDOk() (*string, bool) { + if o == nil || o.BankAccountUUID == nil { + return nil, false + } + return o.BankAccountUUID, true +} + +// HasBankAccountUUID returns a boolean if a field has been set. +func (o *UpdateAccountResponse) HasBankAccountUUID() bool { + if o != nil && o.BankAccountUUID != nil { + return true + } + + return false +} + +// SetBankAccountUUID gets a reference to the given string and assigns it to the BankAccountUUID field. +func (o *UpdateAccountResponse) SetBankAccountUUID(v string) { + o.BankAccountUUID = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *UpdateAccountResponse) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountResponse) GetDescriptionOk() (*string, bool) { + if o == nil || o.Description == nil { + return nil, false + } + return o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *UpdateAccountResponse) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *UpdateAccountResponse) SetDescription(v string) { + o.Description = &v +} + +// GetInvalidFields returns the InvalidFields field value if set, zero value otherwise. +func (o *UpdateAccountResponse) GetInvalidFields() []ErrorFieldType { + if o == nil || o.InvalidFields == nil { + var ret []ErrorFieldType + return ret + } + return *o.InvalidFields +} + +// GetInvalidFieldsOk returns a tuple with the InvalidFields field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountResponse) GetInvalidFieldsOk() (*[]ErrorFieldType, bool) { + if o == nil || o.InvalidFields == nil { + return nil, false + } + return o.InvalidFields, true +} + +// HasInvalidFields returns a boolean if a field has been set. +func (o *UpdateAccountResponse) HasInvalidFields() bool { + if o != nil && o.InvalidFields != nil { + return true + } + + return false +} + +// SetInvalidFields gets a reference to the given []ErrorFieldType and assigns it to the InvalidFields field. +func (o *UpdateAccountResponse) SetInvalidFields(v []ErrorFieldType) { + o.InvalidFields = &v +} + +// GetMetadata returns the Metadata field value if set, zero value otherwise. +func (o *UpdateAccountResponse) GetMetadata() map[string]string { + if o == nil || o.Metadata == nil { + var ret map[string]string + return ret + } + return *o.Metadata +} + +// GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountResponse) GetMetadataOk() (*map[string]string, bool) { + if o == nil || o.Metadata == nil { + return nil, false + } + return o.Metadata, true +} + +// HasMetadata returns a boolean if a field has been set. +func (o *UpdateAccountResponse) HasMetadata() bool { + if o != nil && o.Metadata != nil { + return true + } + + return false +} + +// SetMetadata gets a reference to the given map[string]string and assigns it to the Metadata field. +func (o *UpdateAccountResponse) SetMetadata(v map[string]string) { + o.Metadata = &v +} + +// GetPayoutMethodCode returns the PayoutMethodCode field value if set, zero value otherwise. +func (o *UpdateAccountResponse) GetPayoutMethodCode() string { + if o == nil || o.PayoutMethodCode == nil { + var ret string + return ret + } + return *o.PayoutMethodCode +} + +// GetPayoutMethodCodeOk returns a tuple with the PayoutMethodCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountResponse) GetPayoutMethodCodeOk() (*string, bool) { + if o == nil || o.PayoutMethodCode == nil { + return nil, false + } + return o.PayoutMethodCode, true +} + +// HasPayoutMethodCode returns a boolean if a field has been set. +func (o *UpdateAccountResponse) HasPayoutMethodCode() bool { + if o != nil && o.PayoutMethodCode != nil { + return true + } + + return false +} + +// SetPayoutMethodCode gets a reference to the given string and assigns it to the PayoutMethodCode field. +func (o *UpdateAccountResponse) SetPayoutMethodCode(v string) { + o.PayoutMethodCode = &v +} + +// GetPayoutSchedule returns the PayoutSchedule field value if set, zero value otherwise. +func (o *UpdateAccountResponse) GetPayoutSchedule() PayoutScheduleResponse { + if o == nil || o.PayoutSchedule == nil { + var ret PayoutScheduleResponse + return ret + } + return *o.PayoutSchedule +} + +// GetPayoutScheduleOk returns a tuple with the PayoutSchedule field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountResponse) GetPayoutScheduleOk() (*PayoutScheduleResponse, bool) { + if o == nil || o.PayoutSchedule == nil { + return nil, false + } + return o.PayoutSchedule, true +} + +// HasPayoutSchedule returns a boolean if a field has been set. +func (o *UpdateAccountResponse) HasPayoutSchedule() bool { + if o != nil && o.PayoutSchedule != nil { + return true + } + + return false +} + +// SetPayoutSchedule gets a reference to the given PayoutScheduleResponse and assigns it to the PayoutSchedule field. +func (o *UpdateAccountResponse) SetPayoutSchedule(v PayoutScheduleResponse) { + o.PayoutSchedule = &v +} + +// GetPayoutSpeed returns the PayoutSpeed field value if set, zero value otherwise. +func (o *UpdateAccountResponse) GetPayoutSpeed() string { + if o == nil || o.PayoutSpeed == nil { + var ret string + return ret + } + return *o.PayoutSpeed +} + +// GetPayoutSpeedOk returns a tuple with the PayoutSpeed field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountResponse) GetPayoutSpeedOk() (*string, bool) { + if o == nil || o.PayoutSpeed == nil { + return nil, false + } + return o.PayoutSpeed, true +} + +// HasPayoutSpeed returns a boolean if a field has been set. +func (o *UpdateAccountResponse) HasPayoutSpeed() bool { + if o != nil && o.PayoutSpeed != nil { + return true + } + + return false +} + +// SetPayoutSpeed gets a reference to the given string and assigns it to the PayoutSpeed field. +func (o *UpdateAccountResponse) SetPayoutSpeed(v string) { + o.PayoutSpeed = &v +} + +// GetPspReference returns the PspReference field value if set, zero value otherwise. +func (o *UpdateAccountResponse) GetPspReference() string { + if o == nil || o.PspReference == nil { + var ret string + return ret + } + return *o.PspReference +} + +// GetPspReferenceOk returns a tuple with the PspReference field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountResponse) GetPspReferenceOk() (*string, bool) { + if o == nil || o.PspReference == nil { + return nil, false + } + return o.PspReference, true +} + +// HasPspReference returns a boolean if a field has been set. +func (o *UpdateAccountResponse) HasPspReference() bool { + if o != nil && o.PspReference != nil { + return true + } + + return false +} + +// SetPspReference gets a reference to the given string and assigns it to the PspReference field. +func (o *UpdateAccountResponse) SetPspReference(v string) { + o.PspReference = &v +} + +// GetResultCode returns the ResultCode field value if set, zero value otherwise. +func (o *UpdateAccountResponse) GetResultCode() string { + if o == nil || o.ResultCode == nil { + var ret string + return ret + } + return *o.ResultCode +} + +// GetResultCodeOk returns a tuple with the ResultCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *UpdateAccountResponse) GetResultCodeOk() (*string, bool) { + if o == nil || o.ResultCode == nil { + return nil, false + } + return o.ResultCode, true +} + +// HasResultCode returns a boolean if a field has been set. +func (o *UpdateAccountResponse) HasResultCode() bool { + if o != nil && o.ResultCode != nil { + return true + } + + return false +} + +// SetResultCode gets a reference to the given string and assigns it to the ResultCode field. +func (o *UpdateAccountResponse) SetResultCode(v string) { + o.ResultCode = &v +} + +func (o UpdateAccountResponse) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["accountCode"] = o.AccountCode + } + if o.BankAccountUUID != nil { + toSerialize["bankAccountUUID"] = o.BankAccountUUID + } + if o.Description != nil { + toSerialize["description"] = o.Description + } + if o.InvalidFields != nil { + toSerialize["invalidFields"] = o.InvalidFields + } + if o.Metadata != nil { + toSerialize["metadata"] = o.Metadata + } + if o.PayoutMethodCode != nil { + toSerialize["payoutMethodCode"] = o.PayoutMethodCode + } + if o.PayoutSchedule != nil { + toSerialize["payoutSchedule"] = o.PayoutSchedule + } + if o.PayoutSpeed != nil { + toSerialize["payoutSpeed"] = o.PayoutSpeed + } + if o.PspReference != nil { + toSerialize["pspReference"] = o.PspReference + } + if o.ResultCode != nil { + toSerialize["resultCode"] = o.ResultCode + } + return json.Marshal(toSerialize) +} + +type NullableUpdateAccountResponse struct { + value *UpdateAccountResponse + isSet bool +} + +func (v NullableUpdateAccountResponse) Get() *UpdateAccountResponse { + return v.value +} + +func (v *NullableUpdateAccountResponse) Set(val *UpdateAccountResponse) { + v.value = val + v.isSet = true +} + +func (v NullableUpdateAccountResponse) IsSet() bool { + return v.isSet +} + +func (v *NullableUpdateAccountResponse) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableUpdateAccountResponse(val *UpdateAccountResponse) *NullableUpdateAccountResponse { + return &NullableUpdateAccountResponse{value: val, isSet: true} +} + +func (v NullableUpdateAccountResponse) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableUpdateAccountResponse) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_vias_address.go b/src/platformsnotificationevents/model_vias_address.go new file mode 100644 index 000000000..761bbc013 --- /dev/null +++ b/src/platformsnotificationevents/model_vias_address.go @@ -0,0 +1,295 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// ViasAddress struct for ViasAddress +type ViasAddress struct { + // The name of the city. >Required if either `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided. + City *string `json:"city,omitempty"` + // The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + Country string `json:"country"` + // The number or name of the house. + HouseNumberOrName *string `json:"houseNumberOrName,omitempty"` + // The postal code. >A maximum of five (5) digits for an address in the USA, or a maximum of ten (10) characters for an address in all other countries. >Required if either `houseNumberOrName`, `street`, `city`, or `stateOrProvince` are provided. + PostalCode *string `json:"postalCode,omitempty"` + // The abbreviation of the state or province. >Two (2) characters for an address in the USA or Canada, or a maximum of three (3) characters for an address in all other countries. >Required for an address in the USA or Canada if either `houseNumberOrName`, `street`, `city`, or `postalCode` are provided. + StateOrProvince *string `json:"stateOrProvince,omitempty"` + // The name of the street. >The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. >Required if either `houseNumberOrName`, `city`, `postalCode`, or `stateOrProvince` are provided. + Street *string `json:"street,omitempty"` +} + +// NewViasAddress instantiates a new ViasAddress object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewViasAddress(country string, ) *ViasAddress { + this := ViasAddress{} + this.Country = country + return &this +} + +// NewViasAddressWithDefaults instantiates a new ViasAddress object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewViasAddressWithDefaults() *ViasAddress { + this := ViasAddress{} + return &this +} + +// GetCity returns the City field value if set, zero value otherwise. +func (o *ViasAddress) GetCity() string { + if o == nil || o.City == nil { + var ret string + return ret + } + return *o.City +} + +// GetCityOk returns a tuple with the City field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ViasAddress) GetCityOk() (*string, bool) { + if o == nil || o.City == nil { + return nil, false + } + return o.City, true +} + +// HasCity returns a boolean if a field has been set. +func (o *ViasAddress) HasCity() bool { + if o != nil && o.City != nil { + return true + } + + return false +} + +// SetCity gets a reference to the given string and assigns it to the City field. +func (o *ViasAddress) SetCity(v string) { + o.City = &v +} + +// GetCountry returns the Country field value +func (o *ViasAddress) GetCountry() string { + if o == nil { + var ret string + return ret + } + + return o.Country +} + +// GetCountryOk returns a tuple with the Country field value +// and a boolean to check if the value has been set. +func (o *ViasAddress) GetCountryOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Country, true +} + +// SetCountry sets field value +func (o *ViasAddress) SetCountry(v string) { + o.Country = v +} + +// GetHouseNumberOrName returns the HouseNumberOrName field value if set, zero value otherwise. +func (o *ViasAddress) GetHouseNumberOrName() string { + if o == nil || o.HouseNumberOrName == nil { + var ret string + return ret + } + return *o.HouseNumberOrName +} + +// GetHouseNumberOrNameOk returns a tuple with the HouseNumberOrName field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ViasAddress) GetHouseNumberOrNameOk() (*string, bool) { + if o == nil || o.HouseNumberOrName == nil { + return nil, false + } + return o.HouseNumberOrName, true +} + +// HasHouseNumberOrName returns a boolean if a field has been set. +func (o *ViasAddress) HasHouseNumberOrName() bool { + if o != nil && o.HouseNumberOrName != nil { + return true + } + + return false +} + +// SetHouseNumberOrName gets a reference to the given string and assigns it to the HouseNumberOrName field. +func (o *ViasAddress) SetHouseNumberOrName(v string) { + o.HouseNumberOrName = &v +} + +// GetPostalCode returns the PostalCode field value if set, zero value otherwise. +func (o *ViasAddress) GetPostalCode() string { + if o == nil || o.PostalCode == nil { + var ret string + return ret + } + return *o.PostalCode +} + +// GetPostalCodeOk returns a tuple with the PostalCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ViasAddress) GetPostalCodeOk() (*string, bool) { + if o == nil || o.PostalCode == nil { + return nil, false + } + return o.PostalCode, true +} + +// HasPostalCode returns a boolean if a field has been set. +func (o *ViasAddress) HasPostalCode() bool { + if o != nil && o.PostalCode != nil { + return true + } + + return false +} + +// SetPostalCode gets a reference to the given string and assigns it to the PostalCode field. +func (o *ViasAddress) SetPostalCode(v string) { + o.PostalCode = &v +} + +// GetStateOrProvince returns the StateOrProvince field value if set, zero value otherwise. +func (o *ViasAddress) GetStateOrProvince() string { + if o == nil || o.StateOrProvince == nil { + var ret string + return ret + } + return *o.StateOrProvince +} + +// GetStateOrProvinceOk returns a tuple with the StateOrProvince field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ViasAddress) GetStateOrProvinceOk() (*string, bool) { + if o == nil || o.StateOrProvince == nil { + return nil, false + } + return o.StateOrProvince, true +} + +// HasStateOrProvince returns a boolean if a field has been set. +func (o *ViasAddress) HasStateOrProvince() bool { + if o != nil && o.StateOrProvince != nil { + return true + } + + return false +} + +// SetStateOrProvince gets a reference to the given string and assigns it to the StateOrProvince field. +func (o *ViasAddress) SetStateOrProvince(v string) { + o.StateOrProvince = &v +} + +// GetStreet returns the Street field value if set, zero value otherwise. +func (o *ViasAddress) GetStreet() string { + if o == nil || o.Street == nil { + var ret string + return ret + } + return *o.Street +} + +// GetStreetOk returns a tuple with the Street field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ViasAddress) GetStreetOk() (*string, bool) { + if o == nil || o.Street == nil { + return nil, false + } + return o.Street, true +} + +// HasStreet returns a boolean if a field has been set. +func (o *ViasAddress) HasStreet() bool { + if o != nil && o.Street != nil { + return true + } + + return false +} + +// SetStreet gets a reference to the given string and assigns it to the Street field. +func (o *ViasAddress) SetStreet(v string) { + o.Street = &v +} + +func (o ViasAddress) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.City != nil { + toSerialize["city"] = o.City + } + if true { + toSerialize["country"] = o.Country + } + if o.HouseNumberOrName != nil { + toSerialize["houseNumberOrName"] = o.HouseNumberOrName + } + if o.PostalCode != nil { + toSerialize["postalCode"] = o.PostalCode + } + if o.StateOrProvince != nil { + toSerialize["stateOrProvince"] = o.StateOrProvince + } + if o.Street != nil { + toSerialize["street"] = o.Street + } + return json.Marshal(toSerialize) +} + +type NullableViasAddress struct { + value *ViasAddress + isSet bool +} + +func (v NullableViasAddress) Get() *ViasAddress { + return v.value +} + +func (v *NullableViasAddress) Set(val *ViasAddress) { + v.value = val + v.isSet = true +} + +func (v NullableViasAddress) IsSet() bool { + return v.isSet +} + +func (v *NullableViasAddress) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableViasAddress(val *ViasAddress) *NullableViasAddress { + return &NullableViasAddress{value: val, isSet: true} +} + +func (v NullableViasAddress) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableViasAddress) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_vias_name.go b/src/platformsnotificationevents/model_vias_name.go new file mode 100644 index 000000000..d2cd8e183 --- /dev/null +++ b/src/platformsnotificationevents/model_vias_name.go @@ -0,0 +1,207 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// ViasName struct for ViasName +type ViasName struct { + // The first name. + FirstName string `json:"firstName"` + // The gender. >The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`. + Gender string `json:"gender"` + // The name's infix, if applicable. >A maximum length of twenty (20) characters is imposed. + Infix *string `json:"infix,omitempty"` + // The last name. + LastName string `json:"lastName"` +} + +// NewViasName instantiates a new ViasName object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewViasName(firstName string, gender string, lastName string, ) *ViasName { + this := ViasName{} + this.FirstName = firstName + this.Gender = gender + this.LastName = lastName + return &this +} + +// NewViasNameWithDefaults instantiates a new ViasName object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewViasNameWithDefaults() *ViasName { + this := ViasName{} + return &this +} + +// GetFirstName returns the FirstName field value +func (o *ViasName) GetFirstName() string { + if o == nil { + var ret string + return ret + } + + return o.FirstName +} + +// GetFirstNameOk returns a tuple with the FirstName field value +// and a boolean to check if the value has been set. +func (o *ViasName) GetFirstNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.FirstName, true +} + +// SetFirstName sets field value +func (o *ViasName) SetFirstName(v string) { + o.FirstName = v +} + +// GetGender returns the Gender field value +func (o *ViasName) GetGender() string { + if o == nil { + var ret string + return ret + } + + return o.Gender +} + +// GetGenderOk returns a tuple with the Gender field value +// and a boolean to check if the value has been set. +func (o *ViasName) GetGenderOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.Gender, true +} + +// SetGender sets field value +func (o *ViasName) SetGender(v string) { + o.Gender = v +} + +// GetInfix returns the Infix field value if set, zero value otherwise. +func (o *ViasName) GetInfix() string { + if o == nil || o.Infix == nil { + var ret string + return ret + } + return *o.Infix +} + +// GetInfixOk returns a tuple with the Infix field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ViasName) GetInfixOk() (*string, bool) { + if o == nil || o.Infix == nil { + return nil, false + } + return o.Infix, true +} + +// HasInfix returns a boolean if a field has been set. +func (o *ViasName) HasInfix() bool { + if o != nil && o.Infix != nil { + return true + } + + return false +} + +// SetInfix gets a reference to the given string and assigns it to the Infix field. +func (o *ViasName) SetInfix(v string) { + o.Infix = &v +} + +// GetLastName returns the LastName field value +func (o *ViasName) GetLastName() string { + if o == nil { + var ret string + return ret + } + + return o.LastName +} + +// GetLastNameOk returns a tuple with the LastName field value +// and a boolean to check if the value has been set. +func (o *ViasName) GetLastNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.LastName, true +} + +// SetLastName sets field value +func (o *ViasName) SetLastName(v string) { + o.LastName = v +} + +func (o ViasName) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["firstName"] = o.FirstName + } + if true { + toSerialize["gender"] = o.Gender + } + if o.Infix != nil { + toSerialize["infix"] = o.Infix + } + if true { + toSerialize["lastName"] = o.LastName + } + return json.Marshal(toSerialize) +} + +type NullableViasName struct { + value *ViasName + isSet bool +} + +func (v NullableViasName) Get() *ViasName { + return v.value +} + +func (v *NullableViasName) Set(val *ViasName) { + v.value = val + v.isSet = true +} + +func (v NullableViasName) IsSet() bool { + return v.isSet +} + +func (v *NullableViasName) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableViasName(val *ViasName) *NullableViasName { + return &NullableViasName{value: val, isSet: true} +} + +func (v NullableViasName) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableViasName) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_vias_personal_data.go b/src/platformsnotificationevents/model_vias_personal_data.go new file mode 100644 index 000000000..8ab33e851 --- /dev/null +++ b/src/platformsnotificationevents/model_vias_personal_data.go @@ -0,0 +1,191 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// ViasPersonalData struct for ViasPersonalData +type ViasPersonalData struct { + // The date of birth of the person. The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31). + DateOfBirth *string `json:"dateOfBirth,omitempty"` + // Key value pairs of document type and identify numbers + DocumentData *[]PersonalDocumentData `json:"documentData,omitempty"` + // The nationality of the person represented by a two-character country code. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). + Nationality *string `json:"nationality,omitempty"` +} + +// NewViasPersonalData instantiates a new ViasPersonalData object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewViasPersonalData() *ViasPersonalData { + this := ViasPersonalData{} + return &this +} + +// NewViasPersonalDataWithDefaults instantiates a new ViasPersonalData object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewViasPersonalDataWithDefaults() *ViasPersonalData { + this := ViasPersonalData{} + return &this +} + +// GetDateOfBirth returns the DateOfBirth field value if set, zero value otherwise. +func (o *ViasPersonalData) GetDateOfBirth() string { + if o == nil || o.DateOfBirth == nil { + var ret string + return ret + } + return *o.DateOfBirth +} + +// GetDateOfBirthOk returns a tuple with the DateOfBirth field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ViasPersonalData) GetDateOfBirthOk() (*string, bool) { + if o == nil || o.DateOfBirth == nil { + return nil, false + } + return o.DateOfBirth, true +} + +// HasDateOfBirth returns a boolean if a field has been set. +func (o *ViasPersonalData) HasDateOfBirth() bool { + if o != nil && o.DateOfBirth != nil { + return true + } + + return false +} + +// SetDateOfBirth gets a reference to the given string and assigns it to the DateOfBirth field. +func (o *ViasPersonalData) SetDateOfBirth(v string) { + o.DateOfBirth = &v +} + +// GetDocumentData returns the DocumentData field value if set, zero value otherwise. +func (o *ViasPersonalData) GetDocumentData() []PersonalDocumentData { + if o == nil || o.DocumentData == nil { + var ret []PersonalDocumentData + return ret + } + return *o.DocumentData +} + +// GetDocumentDataOk returns a tuple with the DocumentData field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ViasPersonalData) GetDocumentDataOk() (*[]PersonalDocumentData, bool) { + if o == nil || o.DocumentData == nil { + return nil, false + } + return o.DocumentData, true +} + +// HasDocumentData returns a boolean if a field has been set. +func (o *ViasPersonalData) HasDocumentData() bool { + if o != nil && o.DocumentData != nil { + return true + } + + return false +} + +// SetDocumentData gets a reference to the given []PersonalDocumentData and assigns it to the DocumentData field. +func (o *ViasPersonalData) SetDocumentData(v []PersonalDocumentData) { + o.DocumentData = &v +} + +// GetNationality returns the Nationality field value if set, zero value otherwise. +func (o *ViasPersonalData) GetNationality() string { + if o == nil || o.Nationality == nil { + var ret string + return ret + } + return *o.Nationality +} + +// GetNationalityOk returns a tuple with the Nationality field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ViasPersonalData) GetNationalityOk() (*string, bool) { + if o == nil || o.Nationality == nil { + return nil, false + } + return o.Nationality, true +} + +// HasNationality returns a boolean if a field has been set. +func (o *ViasPersonalData) HasNationality() bool { + if o != nil && o.Nationality != nil { + return true + } + + return false +} + +// SetNationality gets a reference to the given string and assigns it to the Nationality field. +func (o *ViasPersonalData) SetNationality(v string) { + o.Nationality = &v +} + +func (o ViasPersonalData) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if o.DateOfBirth != nil { + toSerialize["dateOfBirth"] = o.DateOfBirth + } + if o.DocumentData != nil { + toSerialize["documentData"] = o.DocumentData + } + if o.Nationality != nil { + toSerialize["nationality"] = o.Nationality + } + return json.Marshal(toSerialize) +} + +type NullableViasPersonalData struct { + value *ViasPersonalData + isSet bool +} + +func (v NullableViasPersonalData) Get() *ViasPersonalData { + return v.value +} + +func (v *NullableViasPersonalData) Set(val *ViasPersonalData) { + v.value = val + v.isSet = true +} + +func (v NullableViasPersonalData) IsSet() bool { + return v.isSet +} + +func (v *NullableViasPersonalData) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableViasPersonalData(val *ViasPersonalData) *NullableViasPersonalData { + return &NullableViasPersonalData{value: val, isSet: true} +} + +func (v NullableViasPersonalData) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableViasPersonalData) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/platformsnotificationevents/model_vias_phone_number.go b/src/platformsnotificationevents/model_vias_phone_number.go new file mode 100644 index 000000000..5bd183c44 --- /dev/null +++ b/src/platformsnotificationevents/model_vias_phone_number.go @@ -0,0 +1,177 @@ +/* + * Adyen for Platforms: Notifications + * + * The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification. For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications). + * + * API version: 6 + * Contact: support@adyen.com + */ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package platformsnotificationevents + +import ( + "encoding/json" +) + +// ViasPhoneNumber struct for ViasPhoneNumber +type ViasPhoneNumber struct { + // The two-character country code of the phone number. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). + PhoneCountryCode string `json:"phoneCountryCode"` + // The phone number. >The inclusion of the phone number country code is not necessary. + PhoneNumber string `json:"phoneNumber"` + // The type of the phone number. >The following values are permitted: `Landline`, `Mobile`, `SIP`, `Fax`. + PhoneType *string `json:"phoneType,omitempty"` +} + +// NewViasPhoneNumber instantiates a new ViasPhoneNumber object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewViasPhoneNumber(phoneCountryCode string, phoneNumber string, ) *ViasPhoneNumber { + this := ViasPhoneNumber{} + this.PhoneCountryCode = phoneCountryCode + this.PhoneNumber = phoneNumber + return &this +} + +// NewViasPhoneNumberWithDefaults instantiates a new ViasPhoneNumber object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewViasPhoneNumberWithDefaults() *ViasPhoneNumber { + this := ViasPhoneNumber{} + return &this +} + +// GetPhoneCountryCode returns the PhoneCountryCode field value +func (o *ViasPhoneNumber) GetPhoneCountryCode() string { + if o == nil { + var ret string + return ret + } + + return o.PhoneCountryCode +} + +// GetPhoneCountryCodeOk returns a tuple with the PhoneCountryCode field value +// and a boolean to check if the value has been set. +func (o *ViasPhoneNumber) GetPhoneCountryCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PhoneCountryCode, true +} + +// SetPhoneCountryCode sets field value +func (o *ViasPhoneNumber) SetPhoneCountryCode(v string) { + o.PhoneCountryCode = v +} + +// GetPhoneNumber returns the PhoneNumber field value +func (o *ViasPhoneNumber) GetPhoneNumber() string { + if o == nil { + var ret string + return ret + } + + return o.PhoneNumber +} + +// GetPhoneNumberOk returns a tuple with the PhoneNumber field value +// and a boolean to check if the value has been set. +func (o *ViasPhoneNumber) GetPhoneNumberOk() (*string, bool) { + if o == nil { + return nil, false + } + return &o.PhoneNumber, true +} + +// SetPhoneNumber sets field value +func (o *ViasPhoneNumber) SetPhoneNumber(v string) { + o.PhoneNumber = v +} + +// GetPhoneType returns the PhoneType field value if set, zero value otherwise. +func (o *ViasPhoneNumber) GetPhoneType() string { + if o == nil || o.PhoneType == nil { + var ret string + return ret + } + return *o.PhoneType +} + +// GetPhoneTypeOk returns a tuple with the PhoneType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ViasPhoneNumber) GetPhoneTypeOk() (*string, bool) { + if o == nil || o.PhoneType == nil { + return nil, false + } + return o.PhoneType, true +} + +// HasPhoneType returns a boolean if a field has been set. +func (o *ViasPhoneNumber) HasPhoneType() bool { + if o != nil && o.PhoneType != nil { + return true + } + + return false +} + +// SetPhoneType gets a reference to the given string and assigns it to the PhoneType field. +func (o *ViasPhoneNumber) SetPhoneType(v string) { + o.PhoneType = &v +} + +func (o ViasPhoneNumber) MarshalJSON() ([]byte, error) { + toSerialize := map[string]interface{}{} + if true { + toSerialize["phoneCountryCode"] = o.PhoneCountryCode + } + if true { + toSerialize["phoneNumber"] = o.PhoneNumber + } + if o.PhoneType != nil { + toSerialize["phoneType"] = o.PhoneType + } + return json.Marshal(toSerialize) +} + +type NullableViasPhoneNumber struct { + value *ViasPhoneNumber + isSet bool +} + +func (v NullableViasPhoneNumber) Get() *ViasPhoneNumber { + return v.value +} + +func (v *NullableViasPhoneNumber) Set(val *ViasPhoneNumber) { + v.value = val + v.isSet = true +} + +func (v NullableViasPhoneNumber) IsSet() bool { + return v.isSet +} + +func (v *NullableViasPhoneNumber) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableViasPhoneNumber(val *ViasPhoneNumber) *NullableViasPhoneNumber { + return &NullableViasPhoneNumber{value: val, isSet: true} +} + +func (v NullableViasPhoneNumber) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableViasPhoneNumber) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/src/recurring/api/openapi.yaml b/src/recurring/api/openapi.yaml index e69c795a3..523b2ed12 100644 --- a/src/recurring/api/openapi.yaml +++ b/src/recurring/api/openapi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.0.3 info: contact: email: support@adyen.com @@ -38,6 +38,7 @@ paths: Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/). + operationId: post-disable requestBody: content: application/json: @@ -52,14 +53,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Disables stored payment details. x-groupName: General x-sortIndex: 2 @@ -69,6 +70,7 @@ paths: Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/). + operationId: post-listRecurringDetails requestBody: content: application/json: @@ -83,14 +85,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Retrieves stored payment details for a shopper. x-groupName: General x-sortIndex: 1 @@ -100,6 +102,7 @@ paths: When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory. + operationId: post-scheduleAccountUpdater requestBody: content: application/json: @@ -114,14 +117,14 @@ paths: description: OK - the request has succeeded. "400": description: Bad Request - a problem reading or understanding the request. - "422": - description: Unprocessable Entity - a request validation error. "401": description: Unauthorized - authentication required. - "500": - description: Internal Server Error - the server could not process the request. "403": description: Forbidden - insufficient permissions to process the request. + "422": + description: Unprocessable Entity - a request validation error. + "500": + description: Internal Server Error - the server could not process the request. summary: Schedules running of the Account Updater. x-groupName: General x-sortIndex: 3 @@ -439,7 +442,8 @@ components: contractTypes: - contractTypes - contractTypes - additionalData: '{}' + additionalData: + key: additionalData billingAddress: country: country stateOrProvince: stateOrProvince @@ -459,6 +463,8 @@ components: expiryYear: expiryYear properties: additionalData: + additionalProperties: + type: string description: |- This field contains additional data, which may be returned in a particular response. @@ -571,7 +577,8 @@ components: contractTypes: - contractTypes - contractTypes - additionalData: '{}' + additionalData: + key: additionalData billingAddress: country: country stateOrProvince: stateOrProvince @@ -615,7 +622,8 @@ components: contractTypes: - contractTypes - contractTypes - additionalData: '{}' + additionalData: + key: additionalData billingAddress: country: country stateOrProvince: stateOrProvince @@ -657,7 +665,8 @@ components: reference: reference merchantAccount: merchantAccount selectedRecurringDetailReference: selectedRecurringDetailReference - additionalData: '{}' + additionalData: + key: additionalData card: cvc: cvc number: number @@ -670,6 +679,8 @@ components: shopperReference: shopperReference properties: additionalData: + additionalProperties: + type: string description: This field contains additional data, which may be required for a particular request. type: object @@ -714,5 +725,13 @@ components: required: - pspReference - result + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http x-groups: - General diff --git a/src/recurring/api_default.go b/src/recurring/api_default.go index fe5efcd7c..d21c45ccb 100644 --- a/src/recurring/api_default.go +++ b/src/recurring/api_default.go @@ -14,47 +14,47 @@ import ( _context "context" _nethttp "net/http" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // Recurring Recurring service type Recurring common.Service /* -Disable Disables stored payment details. +PostDisable Disables stored payment details. Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/). - * @param request DisableRequest - reference of DisableRequest). + * @param request DisableRequest - reference of DisableRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return DisableResult */ func (a Recurring) Disable(req *DisableRequest, ctxs ..._context.Context) (DisableResult, *_nethttp.Response, error) { - res := &DisableResult{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/disable", ctxs...) - return *res, httpRes, err + res := &DisableResult{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/disable", ctxs...) + return *res, httpRes, err } /* -ListRecurringDetails Retrieves stored payment details for a shopper. +PostListRecurringDetails Retrieves stored payment details for a shopper. Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/). - * @param request RecurringDetailsRequest - reference of RecurringDetailsRequest). + * @param request RecurringDetailsRequest - reference of RecurringDetailsRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return RecurringDetailsResult */ func (a Recurring) ListRecurringDetails(req *RecurringDetailsRequest, ctxs ..._context.Context) (RecurringDetailsResult, *_nethttp.Response, error) { - res := &RecurringDetailsResult{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/listRecurringDetails", ctxs...) - return *res, httpRes, err + res := &RecurringDetailsResult{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/listRecurringDetails", ctxs...) + return *res, httpRes, err } /* -ScheduleAccountUpdater Schedules running of the Account Updater. +PostScheduleAccountUpdater Schedules running of the Account Updater. When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory. - * @param request ScheduleAccountUpdaterRequest - reference of ScheduleAccountUpdaterRequest). + * @param request ScheduleAccountUpdaterRequest - reference of ScheduleAccountUpdaterRequest). * @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ScheduleAccountUpdaterResult */ func (a Recurring) ScheduleAccountUpdater(req *ScheduleAccountUpdaterRequest, ctxs ..._context.Context) (ScheduleAccountUpdaterResult, *_nethttp.Response, error) { - res := &ScheduleAccountUpdaterResult{} - httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath()+"/scheduleAccountUpdater", ctxs...) - return *res, httpRes, err + res := &ScheduleAccountUpdaterResult{} + httpRes, err := a.Client.MakeHTTPPostRequest(req, res, a.BasePath() + "/scheduleAccountUpdater", ctxs...) + return *res, httpRes, err } diff --git a/src/recurring/model_recurring_detail.go b/src/recurring/model_recurring_detail.go index d09764bae..e1178cfcf 100644 --- a/src/recurring/model_recurring_detail.go +++ b/src/recurring/model_recurring_detail.go @@ -9,9 +9,11 @@ */ package recurring + import ( "time" ) + // RecurringDetail struct for RecurringDetail type RecurringDetail struct { // This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value. diff --git a/src/recurring/model_recurring_details_request.go b/src/recurring/model_recurring_details_request.go index efc962a24..91582428e 100644 --- a/src/recurring/model_recurring_details_request.go +++ b/src/recurring/model_recurring_details_request.go @@ -9,6 +9,7 @@ */ package recurring + // RecurringDetailsRequest struct for RecurringDetailsRequest type RecurringDetailsRequest struct { // The merchant account identifier you want to process the (transaction) request with. diff --git a/src/recurring/model_schedule_account_updater_request.go b/src/recurring/model_schedule_account_updater_request.go index 69ae32a0d..29bb69773 100644 --- a/src/recurring/model_schedule_account_updater_request.go +++ b/src/recurring/model_schedule_account_updater_request.go @@ -9,6 +9,7 @@ */ package recurring + // ScheduleAccountUpdaterRequest struct for ScheduleAccountUpdaterRequest type ScheduleAccountUpdaterRequest struct { // This field contains additional data, which may be required for a particular request. diff --git a/templates/go/api.mustache b/templates/go/api.mustache index 27105b591..f982db331 100644 --- a/templates/go/api.mustache +++ b/templates/go/api.mustache @@ -8,7 +8,7 @@ import ( _context "context" _nethttp "net/http" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/common" ) // {{packageName}} {{packageName}} service diff --git a/tests/binlookup_test.go b/tests/binlookup_test.go index 47b4984f4..49630bb66 100644 --- a/tests/binlookup_test.go +++ b/tests/binlookup_test.go @@ -10,9 +10,9 @@ import ( "os" "testing" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/binlookup" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/binlookup" + "github.com/adyen/adyen-go-api-library/v4/src/common" "github.com/joho/godotenv" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" @@ -46,7 +46,7 @@ func Test_Binlookup(t *testing.T) { }) t.Run("Create an API request that should support 3DS1 and 3DS2", func(t *testing.T) { res, httpRes, err := client.BinLookup.Get3dsAvailability(&binlookup.ThreeDSAvailabilityRequest{ - CardNumber: "5454545454545454", + CardNumber: "4917610000000000", MerchantAccount: MerchantAccount, }) diff --git a/tests/checkout_test.go b/tests/checkout_test.go index e282a00e5..53be4d041 100644 --- a/tests/checkout_test.go +++ b/tests/checkout_test.go @@ -8,15 +8,16 @@ package tests import ( "context" + _nethttp "net/http" "os" "strings" "testing" "github.com/google/uuid" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/checkout" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/checkout" + "github.com/adyen/adyen-go-api-library/v4/src/common" "github.com/joho/godotenv" @@ -36,27 +37,11 @@ func Test_Checkout(t *testing.T) { ApiKey: APIKey, Environment: "TEST", }) - //client.GetConfig().Debug = true + // client.GetConfig().Debug = true t.Run("PaymentLinks", func(t *testing.T) { - t.Run("Create an API request that should fail", func(t *testing.T) { - - res, httpRes, err := client.Checkout.PaymentLinks(&checkout.CreatePaymentLinkRequest{ - Amount: checkout.Amount{ - Value: 1250, - Currency: "EUR", - }, - MerchantAccount: MerchantAccount, - }) - - require.NotNil(t, err) - assert.Equal(t, true, strings.Contains(err.Error(), "Reference Missing")) - require.NotNil(t, httpRes) - require.NotNil(t, res) - }) - t.Run("Create an API request that should pass", func(t *testing.T) { - - res, httpRes, err := client.Checkout.PaymentLinks(&checkout.CreatePaymentLinkRequest{ + createPaymentLink := func() (checkout.PaymentLinkResource, *_nethttp.Response, error) { + return client.Checkout.PaymentLinks(&checkout.CreatePaymentLinkRequest{ Reference: "123456781235", Amount: checkout.Amount{ Value: 1250, @@ -76,12 +61,58 @@ func Test_Checkout(t *testing.T) { }, MerchantAccount: MerchantAccount, }) + } + t.Run("Create an API request that should fail", func(t *testing.T) { + + res, httpRes, err := client.Checkout.PaymentLinks(&checkout.CreatePaymentLinkRequest{ + Amount: checkout.Amount{ + Value: 1250, + Currency: "EUR", + }, + MerchantAccount: MerchantAccount, + }) + + require.NotNil(t, err) + assert.Equal(t, true, strings.Contains(err.Error(), "Reference Missing")) + require.NotNil(t, httpRes) + require.NotNil(t, res) + }) + t.Run("Create an API request that should pass", func(t *testing.T) { + res, httpRes, err := createPaymentLink() + + require.Nil(t, err) + require.NotNil(t, httpRes) + assert.Equal(t, 201, httpRes.StatusCode) + require.NotNil(t, res) + assert.Equal(t, checkout.Amount{Currency: "EUR", Value: 1250}, res.Amount) + assert.NotNil(t, res.Url) + }) + + t.Run("Get payment link", func(t *testing.T) { + paymentLink, _, _ := createPaymentLink() + res, httpRes, err := client.Checkout.GetPaymentLink(paymentLink.Id) + + require.Nil(t, err) + require.NotNil(t, httpRes) + assert.Equal(t, 200, httpRes.StatusCode) + require.NotNil(t, res) + assert.Equal(t, paymentLink.Reference, res.Reference) + assert.Equal(t, paymentLink.Status, res.Status) + assert.NotNil(t, res.Url) + }) + + t.Run("Update payment link", func(t *testing.T) { + paymentLink, _, _ := createPaymentLink() + res, httpRes, err := client.Checkout.UpdatePaymentLink(paymentLink.Id, &checkout.UpdatePaymentLinkRequest{ + Status: "expired", + }) require.Nil(t, err) require.NotNil(t, httpRes) assert.Equal(t, 200, httpRes.StatusCode) require.NotNil(t, res) - assert.Equal(t, &checkout.Amount{Currency: "EUR", Value: 1250}, res.Amount) + assert.Equal(t, paymentLink.Reference, res.Reference) + assert.NotEqual(t, paymentLink.Status, res.Status) assert.NotNil(t, res.Url) }) }) @@ -89,7 +120,8 @@ func Test_Checkout(t *testing.T) { t.Run("PaymentMethods", func(t *testing.T) { t.Run("Create an API request that should fail", func(t *testing.T) { - res, httpRes, err := client.Checkout.PaymentMethods(&checkout.PaymentMethodsRequest{}) + res, httpRes, err := + client.Checkout.PaymentMethods(&checkout.PaymentMethodsRequest{}) require.NotNil(t, err) assert.Equal(t, true, strings.Contains(err.Error(), "Invalid Merchant Account (security: 901)")) @@ -118,13 +150,12 @@ func Test_Checkout(t *testing.T) { }) require.NotNil(t, err) - assert.Equal(t, true, strings.Contains(err.Error(), "Unsupported currency specified (validation: 138)")) + assert.Equal(t, true, strings.Contains(err.Error(), "paymentMethod object has not been provided")) require.NotNil(t, httpRes) assert.Equal(t, 422, httpRes.StatusCode) require.NotNil(t, res) }) t.Run("Create an API request that should pass", func(t *testing.T) { - req := &checkout.PaymentRequest{ Reference: "123456781235", Amount: checkout.Amount{ @@ -151,7 +182,6 @@ func Test_Checkout(t *testing.T) { require.NotNil(t, res) assert.Equal(t, common.RedirectShopper, res.ResultCode) require.NotNil(t, res.Action) - assert.Equal(t, "ideal", res.Action.PaymentMethodType) require.NotNil(t, res.PaymentData) // check if req has ApplicationInfo added to it @@ -219,11 +249,11 @@ func Test_Checkout(t *testing.T) { ApplicationInfo: &checkout.ApplicationInfo{ AdyenPaymentSource: &checkout.CommonField{ Name: "test", - Version: "v50", + Version: "v65", }, AdyenLibrary: &checkout.CommonField{ Name: "test", - Version: "v50", + Version: "v65", }, }, } @@ -236,7 +266,6 @@ func Test_Checkout(t *testing.T) { require.NotNil(t, res) assert.Equal(t, common.RedirectShopper, res.ResultCode) require.NotNil(t, res.Action) - assert.Equal(t, "ideal", res.Action.PaymentMethodType) require.NotNil(t, res.PaymentData) // check if req has ApplicationInfo added to it @@ -245,7 +274,7 @@ func Test_Checkout(t *testing.T) { require.Equal(t, common.LibName, req.ApplicationInfo.AdyenLibrary.Name) require.Equal(t, common.LibVersion, req.ApplicationInfo.AdyenLibrary.Version) require.Equal(t, "test", req.ApplicationInfo.AdyenPaymentSource.Name) - require.Equal(t, "v50", req.ApplicationInfo.AdyenPaymentSource.Version) + require.Equal(t, "v65", req.ApplicationInfo.AdyenPaymentSource.Version) }) }) @@ -253,9 +282,9 @@ func Test_Checkout(t *testing.T) { t.Run("Create an API request that should fail", func(t *testing.T) { res, httpRes, err := client.Checkout.PaymentsDetails(&checkout.DetailsRequest{ PaymentData: "1234", - Details: map[string]interface{}{ - "MD": "Ab02b4c0!BQABAgCW5sxB4e/==", - "PaRes": "eNrNV0mTo7gS...", + Details: checkout.PaymentCompletionDetails{ + MD: "Ab02b4c0!BQABAgCW5sxB4e/==", + PaRes: "eNrNV0mTo7gS...", }, }) @@ -322,4 +351,87 @@ func Test_Checkout(t *testing.T) { require.NotNil(t, res) }) }) + + t.Run("Utility", func(t *testing.T) { + t.Run("Get origin keys", func(t *testing.T) { + domain := "https://adyen.com" + res, httpRes, err := client.Checkout.OriginKeys(&checkout.CheckoutUtilityRequest{ + OriginDomains: []string{ + domain, + }, + }) + require.Nil(t, err) + require.NotNil(t, httpRes) + assert.Equal(t, 200, httpRes.StatusCode) + require.NotNil(t, res) + originKeys := res.OriginKeys + assert.NotEmpty(t, originKeys[domain]) + }) + }) + + t.Run("Orders", func(t *testing.T) { + t.Run("Get balance", func(t *testing.T) { + t.Skip("Payment method not correctly configured in the backoffice") + res, httpRes, err := client.Checkout.PaymentMethodsBalance(&checkout.CheckoutBalanceCheckRequest{ + MerchantAccount: MerchantAccount, + PaymentMethod: map[string]interface{}{ + "type": "giftcard", + "brand": "givex", + "number": "603628672882001915092", + "holderName": "balance EUR 100", + "cvc": "5754", + "additionalAmount": map[string]interface{}{ + "currency": "EUR", + "value": 0, + }, + }, + }) + + require.Nil(t, err) + require.NotNil(t, httpRes) + assert.Equal(t, 200, httpRes.StatusCode) + require.NotNil(t, res) + assert.Equal(t, int64(100), res.Balance.Value) + }) + t.Run("Create order", func(t *testing.T) { + res, httpRes, err := client.Checkout.Orders(&checkout.CheckoutCreateOrderRequest{ + Amount: checkout.Amount{ + Currency: "EUR", + Value: 1000, + }, + MerchantAccount: MerchantAccount, + Reference: "CREATE_ORDER_REF", + }) + + require.Nil(t, err) + require.NotNil(t, httpRes) + assert.Equal(t, 200, httpRes.StatusCode) + require.NotNil(t, res) + assert.Equal(t, int64(1000), res.RemainingAmount.Value) + }) + t.Run("Cancel order", func(t *testing.T) { + order, _, _ := client.Checkout.Orders(&checkout.CheckoutCreateOrderRequest{ + Amount: checkout.Amount{ + Currency: "EUR", + Value: 1000, + }, + MerchantAccount: MerchantAccount, + Reference: "CREATE_ORDER_REF", + }) + + res, httpRes, err := client.Checkout.OrdersCancel(&checkout.CheckoutCancelOrderRequest{ + MerchantAccount: MerchantAccount, + Order: checkout.CheckoutOrder{ + OrderData: order.OrderData, + PspReference: order.PspReference, + }, + }) + + require.Nil(t, err) + require.NotNil(t, httpRes) + assert.Equal(t, 200, httpRes.StatusCode) + require.NotNil(t, res) + assert.Equal(t, "Received", res.ResultCode) + }) + }) } diff --git a/tests/checkoutidempotency_test.go b/tests/checkoutidempotency_test.go index 4bd6d56f0..6b76b3bdb 100644 --- a/tests/checkoutidempotency_test.go +++ b/tests/checkoutidempotency_test.go @@ -11,9 +11,9 @@ import ( "testing" "time" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/checkout" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/checkout" + "github.com/adyen/adyen-go-api-library/v4/src/common" "github.com/google/uuid" "github.com/stretchr/testify/require" ) diff --git a/tests/checkoututility_test.go b/tests/checkoututility_test.go deleted file mode 100644 index 1c1c5e953..000000000 --- a/tests/checkoututility_test.go +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Adyen API Client - * - * Contact: support@adyen.com - */ - -package tests - -import ( - "os" - "strings" - "testing" - - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/checkoututility" - "github.com/adyen/adyen-go-api-library/v3/src/common" - "github.com/joho/godotenv" - - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" -) - -func Test_CheckoutUtility(t *testing.T) { - godotenv.Load("./../.env") - - var ( - APIKey = os.Getenv("ADYEN_API_KEY") - ) - - client := adyen.NewClient(&common.Config{ - ApiKey: APIKey, - Environment: "TEST", - }) - // client.GetConfig().Debug = true - - t.Run("OriginKeys", func(t *testing.T) { - t.Run("Create an API request that should fail", func(t *testing.T) { - res, httpRes, err := client.CheckoutUtility.OriginKeys(&checkoututility.CheckoutUtilityRequest{}) - require.NotNil(t, err) - require.NotNil(t, httpRes) - assert.Equal(t, true, strings.Contains(err.Error(), "Required field 'originDomains' is null")) - assert.Equal(t, 400, httpRes.StatusCode) - require.NotNil(t, res) - }) - t.Run("Create an API request that should pass", func(t *testing.T) { - domain := "http://example.com" - res, httpRes, err := client.CheckoutUtility.OriginKeys(&checkoututility.CheckoutUtilityRequest{ - OriginDomains: []string{domain}, - }) - require.Nil(t, err) - require.NotNil(t, httpRes) - assert.Equal(t, 200, httpRes.StatusCode) - require.NotNil(t, res) - originKeys := *res.OriginKeys - assert.NotEmpty(t, originKeys[domain]) - }) - }) -} diff --git a/tests/disputes_test.go b/tests/disputes_test.go new file mode 100644 index 000000000..3555cacac --- /dev/null +++ b/tests/disputes_test.go @@ -0,0 +1,134 @@ +package tests + +import ( + "os" + "testing" + + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/checkout" + "github.com/adyen/adyen-go-api-library/v4/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/disputes" + "github.com/adyen/adyen-go-api-library/v4/src/payments" + "github.com/joho/godotenv" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func Test_Disputes(t *testing.T) { + godotenv.Load("./../.env") + + var ( + MerchantAccount = os.Getenv("ADYEN_MERCHANT") + APIKey = os.Getenv("ADYEN_API_KEY") + ) + + client := adyen.NewClient(&common.Config{ + ApiKey: APIKey, + Environment: "TEST", + }) + + createTestPayment := func() string { + res, _, _ := client.Checkout.Payments(&checkout.PaymentRequest{ + Amount: checkout.Amount{ + Currency: "EUR", + Value: 1000, + }, + Reference: "DISPUTES_CHARGEBACK", + PaymentMethod: map[string]interface{}{ + "type": "scheme", + "number": "4111111111111111", + "expiryMonth": "03", + "expiryYear": "2030", + "holderName": "chargeback:10.4", + "cvc": "737", + }, + ReturnUrl: "https://adyen.com", + MerchantAccount: MerchantAccount, + }) + captureRes, _, _ := client.Payments.Capture(&payments.ModificationRequest{ + OriginalReference: res.PspReference, + ModificationAmount: &payments.Amount{ + Currency: "EUR", + Value: 1000, + }, + Reference: "MODIFICATION_REFERENCE", + MerchantAccount: MerchantAccount, + }) + return captureRes.PspReference + } + + t.Run("Disputes", func(t *testing.T) { + t.Run("Retrieve applicable defense reasons", func(t *testing.T) { + pspReference := createTestPayment() + res, httpRes, err := client.Disputes.RetrieveApplicableDefenseReasons(&disputes.DefenseReasonsRequest{ + DisputePspReference: pspReference, + MerchantAccountCode: MerchantAccount, + }) + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + assert.NotNil(t, res) + assert.Equal(t, "Dispute not found.", res.DisputeServiceResult.ErrorMessage) + }) + + t.Run("Supply defense document", func(t *testing.T) { + pspReference := createTestPayment() + res, httpRes, err := client.Disputes.SupplyDefenseDocument(&disputes.SupplyDefenseDocumentRequest{ + DefenseDocuments: []disputes.DefenseDocument{ + { + Content: "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==", + ContentType: "image/jpg", + DefenseDocumentTypeCode: "DefenseMaterial", + }, + }, + DisputePspReference: pspReference, + MerchantAccountCode: MerchantAccount, + }) + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + assert.NotNil(t, res) + assert.Equal(t, "Unknown dispute", res.DisputeServiceResult.ErrorMessage) + }) + + t.Run("Delete dispute defense document", func(t *testing.T) { + pspReference := createTestPayment() + res, httpRes, err := client.Disputes.DeleteDisputeDefenseDocument(&disputes.DeleteDefenseDocumentRequest{ + DefenseDocumentType: "DefenseMaterial", + DisputePspReference: pspReference, + MerchantAccountCode: MerchantAccount, + }) + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + assert.NotNil(t, res) + assert.Equal(t, "Unknown dispute", res.DisputeServiceResult.ErrorMessage) + }) + + t.Run("Defend dispute", func(t *testing.T) { + pspReference := createTestPayment() + res, httpRes, err := client.Disputes.DefendDispute(&disputes.DefendDisputeRequest{ + DefenseReasonCode: "DuplicateChargeback", + DisputePspReference: pspReference, + MerchantAccountCode: MerchantAccount, + }) + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + assert.NotNil(t, res) + assert.Equal(t, "Dispute not found.", res.DisputeServiceResult.ErrorMessage) + }) + + t.Run("Download dispute defense document", func(t *testing.T) { + pspReference := createTestPayment() + _, httpRes, err := client.Disputes.DownloadDisputeDefenseDocument(&disputes.DownloadDefenseDocumentRequest{ + DefenseDocumentType: "DefenseMaterial", + DisputePspReference: pspReference, + MerchantAccountCode: MerchantAccount, + }) + + require.NotNil(t, err) + assert.Equal(t, 403, httpRes.StatusCode) + }) + }) +} diff --git a/tests/notification_handler_test.go b/tests/notification_handler_test.go index cc03a1beb..c0f2898f7 100644 --- a/tests/notification_handler_test.go +++ b/tests/notification_handler_test.go @@ -6,9 +6,9 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/common" - "github.com/adyen/adyen-go-api-library/v3/src/notification" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/notification" ) func TestNotificationService_HandleNotificationRequest(t *testing.T) { diff --git a/tests/payment_test.go b/tests/payment_test.go index 4d4f4202a..37adcf956 100644 --- a/tests/payment_test.go +++ b/tests/payment_test.go @@ -6,9 +6,9 @@ import ( "testing" "time" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/common" - "github.com/adyen/adyen-go-api-library/v3/src/payments" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/payments" "github.com/joho/godotenv" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" @@ -61,14 +61,6 @@ func Test_Payment(t *testing.T) { require.NotNil(t, res) } - assertForApplicationInfo := func(req *payments.ModificationRequest) { - // check if req has ApplicationInfo added to it - require.NotNil(t, req.ApplicationInfo) - require.NotNil(t, req.ApplicationInfo.AdyenLibrary) - require.Equal(t, common.LibName, req.ApplicationInfo.AdyenLibrary.Name) - require.Equal(t, common.LibVersion, req.ApplicationInfo.AdyenLibrary.Version) - } - authorisePost := func() (payments.PaymentResult, *http.Response, error) { return client.Payments.Authorise(&payments.PaymentRequest{ Card: &card, @@ -124,11 +116,9 @@ func Test_Payment(t *testing.T) { Reference: time.Now().String(), MerchantAccount: MerchantAccount, } - require.Nil(t, req.ApplicationInfo) res, httpRes, err := client.Payments.AdjustAuthorisation(req) assertForSuccessResponse(res, httpRes, err) assert.Equal(t, "[adjustAuthorisation-received]", res.Response) - assertForApplicationInfo(req) }) t.Run("CancelOrRefund", func(t *testing.T) { @@ -138,11 +128,9 @@ func Test_Payment(t *testing.T) { Reference: time.Now().String(), MerchantAccount: MerchantAccount, } - require.Nil(t, req.ApplicationInfo) res, httpRes, err := client.Payments.CancelOrRefund(req) assertForSuccessResponse(res, httpRes, err) assert.Equal(t, "[cancelOrRefund-received]", res.Response) - assertForApplicationInfo(req) }) t.Run("Cancel", func(t *testing.T) { @@ -152,11 +140,9 @@ func Test_Payment(t *testing.T) { Reference: time.Now().String(), MerchantAccount: MerchantAccount, } - require.Nil(t, req.ApplicationInfo) res, httpRes, err := client.Payments.Cancel(req) assertForSuccessResponse(res, httpRes, err) assert.Equal(t, "[cancel-received]", res.Response) - assertForApplicationInfo(req) }) t.Run("Capture", func(t *testing.T) { @@ -170,11 +156,9 @@ func Test_Payment(t *testing.T) { Reference: time.Now().String(), MerchantAccount: MerchantAccount, } - require.Nil(t, req.ApplicationInfo) res, httpRes, err := client.Payments.Capture(req) assertForSuccessResponse(res, httpRes, err) assert.Equal(t, "[capture-received]", res.Response) - assertForApplicationInfo(req) }) t.Run("Refund", func(t *testing.T) { @@ -188,11 +172,9 @@ func Test_Payment(t *testing.T) { Reference: time.Now().String(), MerchantAccount: MerchantAccount, } - require.Nil(t, req.ApplicationInfo) res, httpRes, err := client.Payments.Refund(req) assertForSuccessResponse(res, httpRes, err) assert.Equal(t, "[refund-received]", res.Response) - assertForApplicationInfo(req) }) t.Run("TechnicalCancel", func(t *testing.T) { @@ -202,11 +184,9 @@ func Test_Payment(t *testing.T) { Reference: time.Now().String(), MerchantAccount: MerchantAccount, } - require.Nil(t, req.ApplicationInfo) res, httpRes, err := client.Payments.TechnicalCancel(req) assertForSuccessResponse(res, httpRes, err) assert.Equal(t, "[technical-cancel-received]", res.Response) - assertForApplicationInfo(req) }) t.Run("VoidPendingRefund", func(t *testing.T) { @@ -216,11 +196,9 @@ func Test_Payment(t *testing.T) { Reference: time.Now().String(), MerchantAccount: MerchantAccount, } - require.Nil(t, req.ApplicationInfo) res, httpRes, err := client.Payments.VoidPendingRefund(req) assertForSuccessResponse(res, httpRes, err) assert.Equal(t, "[voidPendingRefund-received]", res.Response) - assertForApplicationInfo(req) }) }) } diff --git a/tests/payouts_test.go b/tests/payouts_test.go index aba02e0dc..217ee0afc 100644 --- a/tests/payouts_test.go +++ b/tests/payouts_test.go @@ -13,10 +13,10 @@ import ( "testing" "time" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/checkout" - "github.com/adyen/adyen-go-api-library/v3/src/common" - "github.com/adyen/adyen-go-api-library/v3/src/payouts" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/checkout" + "github.com/adyen/adyen-go-api-library/v4/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/payouts" "github.com/joho/godotenv" "github.com/stretchr/testify/assert" diff --git a/tests/platforms_test.go b/tests/platforms_test.go index c5501859d..705d0d99f 100644 --- a/tests/platforms_test.go +++ b/tests/platforms_test.go @@ -15,11 +15,11 @@ import ( "os" "testing" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/common" - "github.com/adyen/adyen-go-api-library/v3/src/platformsaccount" - "github.com/adyen/adyen-go-api-library/v3/src/platformsfund" - "github.com/adyen/adyen-go-api-library/v3/src/platformsnotificationconfiguration" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/platformsaccount" + "github.com/adyen/adyen-go-api-library/v4/src/platformsfund" + "github.com/adyen/adyen-go-api-library/v4/src/platformsnotificationconfiguration" "github.com/google/uuid" "github.com/joho/godotenv" "github.com/stretchr/testify/assert" @@ -46,7 +46,7 @@ func Test_Platforms(t *testing.T) { AccountHolderCode: id, AccountHolderDetails: platformsaccount.AccountHolderDetails{ Email: "go_library@test.com", - FullPhoneNumber: "312030291928", + FullPhoneNumber: "+312030291928", WebAddress: "http://example.com", IndividualDetails: &platformsaccount.IndividualDetails{ Name: &platformsaccount.ViasName{ diff --git a/tests/recurring_test.go b/tests/recurring_test.go index 2d347de11..99cbca231 100644 --- a/tests/recurring_test.go +++ b/tests/recurring_test.go @@ -11,10 +11,10 @@ import ( "strings" "testing" - "github.com/adyen/adyen-go-api-library/v3/src/adyen" - "github.com/adyen/adyen-go-api-library/v3/src/common" + "github.com/adyen/adyen-go-api-library/v4/src/adyen" + "github.com/adyen/adyen-go-api-library/v4/src/common" - "github.com/adyen/adyen-go-api-library/v3/src/recurring" + "github.com/adyen/adyen-go-api-library/v4/src/recurring" "github.com/joho/godotenv" "github.com/stretchr/testify/assert"