diff --git a/src/typings/configurationWebhooks/amount.ts b/src/typings/configurationWebhooks/amount.ts index e35a6e195..edc8881f6 100644 --- a/src/typings/configurationWebhooks/amount.ts +++ b/src/typings/configurationWebhooks/amount.ts @@ -10,11 +10,11 @@ export class Amount { /** - * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes). + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. */ "currency": string; /** - * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). + * The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). */ "value": number; diff --git a/src/typings/configurationWebhooks/bulkAddress.ts b/src/typings/configurationWebhooks/bulkAddress.ts index 6b5251626..d396a5160 100644 --- a/src/typings/configurationWebhooks/bulkAddress.ts +++ b/src/typings/configurationWebhooks/bulkAddress.ts @@ -46,6 +46,10 @@ export class BulkAddress { */ "mobile"?: string; /** + * The recipient’s name (person or contact), for example ‘John Doe’. + */ + "name"?: string; + /** * The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries. */ "postalCode"?: string; @@ -117,6 +121,12 @@ export class BulkAddress { "type": "string", "format": "" }, + { + "name": "name", + "baseName": "name", + "type": "string", + "format": "" + }, { "name": "postalCode", "baseName": "postalCode", diff --git a/src/typings/configurationWebhooks/card.ts b/src/typings/configurationWebhooks/card.ts index 3fd874fc3..b80c5c98f 100644 --- a/src/typings/configurationWebhooks/card.ts +++ b/src/typings/configurationWebhooks/card.ts @@ -49,7 +49,7 @@ export class Card { /** * The primary account number (PAN) of the card. > The PAN is masked by default and returned only for single-use virtual cards. */ - "number": string; + "number"?: string; /** * The 3DS configuration of the physical or the virtual card. Possible values: **fullySupported**, **secureCorporate**. > Reach out to your Adyen contact to get the values relevant for your integration. */ diff --git a/src/typings/configurationWebhooks/cardConfiguration.ts b/src/typings/configurationWebhooks/cardConfiguration.ts index 5d0757c1d..322ab5b8b 100644 --- a/src/typings/configurationWebhooks/cardConfiguration.ts +++ b/src/typings/configurationWebhooks/cardConfiguration.ts @@ -12,7 +12,7 @@ import { BulkAddress } from "./bulkAddress"; export class CardConfiguration { /** - * Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions. + * The activation label attached to the card that contains the activation instructions. This field overrides the activation label design ID defined in the card configuration profile. */ "activation"?: string; /** @@ -21,31 +21,31 @@ export class CardConfiguration { "activationUrl"?: string; "bulkAddress"?: BulkAddress | null; /** - * The ID of the card image. This is the image that will be printed on the full front of the card. + * The unique identifier of the card image. This image is printed on the full front of the card. */ "cardImageId"?: string; /** - * Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached. + * The letter or packaging to which the card is attached. This field overrides the carrier design ID defined in the card configuration profile. */ "carrier"?: string; /** - * The ID of the carrier image. This is the image that will printed on the letter to which the card is attached. + * The unique identifier of the carrier image. This image is printed on the letter to which the card is attached. */ "carrierImageId"?: string; /** - * The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile. + * The unique identifier of the card configuration profile that contains the settings that are applied to the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. You can override some of the existing settings in the configuration profile by providing the corresponding fields in the `configuration` object. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile. */ "configurationProfileId": string; /** - * The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**. + * The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**. This field overrides the existing currency setting on the card configuration profile. */ "currency"?: string; /** - * Overrides the envelope design ID defined in the `configurationProfileId`. + * Overrides the envelope design ID defined in the card configuration profile. */ "envelope"?: string; /** - * Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card. + * Any additional material, such as marketing material, that is shipped together with the card. This field overrides the insert design ID defined in the card configuration profile. */ "insert"?: string; /** @@ -53,15 +53,15 @@ export class CardConfiguration { */ "language"?: string; /** - * The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner. + * The unique identifier of the logo image. This image is printed on the partial front of the card, for example, a logo on the upper right corner. */ "logoImageId"?: string; /** - * Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed. + * The letter on which the PIN of the card is printed. This field overrides the PIN mailer design ID defined in the card configuration profile. */ "pinMailer"?: string; /** - * Overrides the logistics company defined in the `configurationProfileId`. + * The logistics company that ships the card. This field overrides the logistics company defined in the card configuration profile. */ "shipmentMethod"?: string; diff --git a/src/typings/configurationWebhooks/sweepConfigurationV2.ts b/src/typings/configurationWebhooks/sweepConfigurationV2.ts index d3dd16c85..d51d5ff21 100644 --- a/src/typings/configurationWebhooks/sweepConfigurationV2.ts +++ b/src/typings/configurationWebhooks/sweepConfigurationV2.ts @@ -31,7 +31,7 @@ export class SweepConfigurationV2 { */ "id": string; /** - * The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on. The request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed. Possible values: * **regular**: for normal, low-value transactions. * **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: for instant funds transfers within the United States and in [SEPA locations](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: for high-value transfers to a recipient in a different country. * **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup). + * The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on. The request will be accepted as long as **at least one** of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide `[\"wire\",\"regular\"]`, and `wire` is not supported but `regular` is, the request will still be accepted and processed. Possible values: * **regular**: For normal, low-value transactions. * **fast**: A faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: The fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: For instant funds transfers within the United States and in [SEPA locations](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: For high-value transfers to a recipient in a different country. * **internal**: For transfers to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see optional priorities setup for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/scheduled-payouts#optional-priorities-setup) or [platforms](https://docs.adyen.com/platforms/payout-to-users/scheduled-payouts#optional-priorities-setup). */ "priorities"?: Array; /** @@ -211,6 +211,7 @@ export namespace SweepConfigurationV2 { RefusedByCustomer = 'refusedByCustomer', RouteNotFound = 'routeNotFound', ScaFailed = 'scaFailed', + SchemeAdvice = 'schemeAdvice', TransferInstrumentDoesNotExist = 'transferInstrumentDoesNotExist', Unknown = 'unknown' }