Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/typings/transfers/amount.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
10 changes: 10 additions & 0 deletions src/typings/transfers/bankAccountV3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ import { PartyIdentification } from "./partyIdentification";
export class BankAccountV3 {
"accountHolder": PartyIdentification;
"accountIdentification": BankAccountV3AccountIdentification;
/**
* The unique token that identifies the stored bank account details of the counterparty for a payout.
*/
"storedPaymentMethodId"?: string;

static readonly discriminator: string | undefined = undefined;

Expand All @@ -31,6 +35,12 @@ export class BankAccountV3 {
"baseName": "accountIdentification",
"type": "BankAccountV3AccountIdentification",
"format": ""
},
{
"name": "storedPaymentMethodId",
"baseName": "storedPaymentMethodId",
"type": "string",
"format": ""
} ];

static getAttributeTypeMap() {
Expand Down
2 changes: 1 addition & 1 deletion src/typings/transfers/bankCategoryData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

export class BankCategoryData {
/**
* The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. 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).
* The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. 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).
*/
"priority"?: BankCategoryData.PriorityEnum;
/**
Expand Down
71 changes: 71 additions & 0 deletions src/typings/transfers/fundingInstrument.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
* The version of the OpenAPI document: v4
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit this class manually.
*/

import { CardIdentification } from "./cardIdentification";


export class FundingInstrument {
"cardIdentification"?: CardIdentification | null;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider adding a JSDoc comment for the cardIdentification property to improve code clarity and maintainability. All other properties in this class have documentation.

Suggested change
"cardIdentification"?: CardIdentification | null;
/**
* The card details of the funding instrument.
*/
"cardIdentification"?: CardIdentification | null;

/**
* The unique reference assigned by the card network for the pay-in transaction.
*/
"networkPaymentReference"?: string;
/**
* Your internal reference that identifies this funding instrument. Required if `sourceOfFunds` is **DEPOSIT_ACCOUNT**.
*/
"reference"?: string;
/**
* Indicates where the funds used for the transfer originated. Possible values are: - **DEBIT** for card-to-card transfers. - **DEPOSIT_ACCOUNT** for wallet-to-card transfers.
*/
"sourceOfFunds"?: FundingInstrument.SourceOfFundsEnum;

static readonly discriminator: string | undefined = undefined;

static readonly mapping: {[index: string]: string} | undefined = undefined;

static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
{
"name": "cardIdentification",
"baseName": "cardIdentification",
"type": "CardIdentification | null",
"format": ""
},
{
"name": "networkPaymentReference",
"baseName": "networkPaymentReference",
"type": "string",
"format": ""
},
{
"name": "reference",
"baseName": "reference",
"type": "string",
"format": ""
},
{
"name": "sourceOfFunds",
"baseName": "sourceOfFunds",
"type": "FundingInstrument.SourceOfFundsEnum",
"format": ""
} ];

static getAttributeTypeMap() {
return FundingInstrument.attributeTypeMap;
}

public constructor() {
}
}

export namespace FundingInstrument {
export enum SourceOfFundsEnum {
Debit = 'DEBIT',
DepositAccount = 'DEPOSIT_ACCOUNT'
}
}
1 change: 1 addition & 0 deletions src/typings/transfers/models.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export * from "./executionDate"
export * from "./externalReason"
export * from "./fee"
export * from "./findTransfersResponse"
export * from "./fundingInstrument"
export * from "./hKLocalAccountIdentification"
export * from "./hULocalAccountIdentification"
export * from "./ibanAccountIdentification"
Expand Down
3 changes: 3 additions & 0 deletions src/typings/transfers/objectSerializer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import { ExecutionDate } from "./executionDate";
import { ExternalReason } from "./externalReason";
import { Fee } from "./fee";
import { FindTransfersResponse } from "./findTransfersResponse";
import { FundingInstrument } from "./fundingInstrument";
import { HKLocalAccountIdentification } from "./hKLocalAccountIdentification";
import { HULocalAccountIdentification } from "./hULocalAccountIdentification";
import { IbanAccountIdentification } from "./ibanAccountIdentification";
Expand Down Expand Up @@ -122,6 +123,7 @@ let enumsMap: Set<string> = new Set<string>([
"ConfirmationTrackingData.TypeEnum",
"DKLocalAccountIdentification.TypeEnum",
"EstimationTrackingData.TypeEnum",
"FundingInstrument.SourceOfFundsEnum",
"HKLocalAccountIdentification.TypeEnum",
"HULocalAccountIdentification.TypeEnum",
"IbanAccountIdentification.TypeEnum",
Expand Down Expand Up @@ -216,6 +218,7 @@ let typeMap: {[index: string]: any} = {
"ExternalReason": ExternalReason,
"Fee": Fee,
"FindTransfersResponse": FindTransfersResponse,
"FundingInstrument": FundingInstrument,
"HKLocalAccountIdentification": HKLocalAccountIdentification,
"HULocalAccountIdentification": HULocalAccountIdentification,
"IbanAccountIdentification": IbanAccountIdentification,
Expand Down
3 changes: 2 additions & 1 deletion src/typings/transfers/platformPayment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export class PlatformPayment {
*/
"paymentMerchantReference"?: string;
/**
* Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: the acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: the transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). * **AdyenFees**: all transaction fees due to Adyen. This is the aggregated amount of Adyen\'s commission and markup. * **AdyenMarkup**: the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: the amount booked to your user after the deduction of the relevant fees. * **Commission**: your platform\'s or marketplace\'s commission on a transaction. * **DCCPlatformCommission**: the Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: the interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: the aggregated amount of all transaction fees. * **Remainder**: the leftover amount after currency conversion. * **SchemeFee**: the scheme fee incurred on a transaction. * **Surcharge**: the surcharge paid by the customer on a transaction. * **Tip**: the tip paid by the customer. * **TopUp**: an incoming transfer to top up your user\'s balance account. * **VAT**: the value-added tax charged on the payment.
* Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). * **AdyenFees**: All transaction fees due to Adyen. This is the aggregated amount of Adyen\'s commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform\'s or marketplace\'s commission on a transaction. * **DCCPlatformCommission**: **deprecated** The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: The Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user\'s balance account. * **VAT**: The value-added tax charged on the payment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To improve clarity around the deprecation, consider updating the descriptions for DCCPlatformCommission and DCCMarkup to explicitly mention the replacement relationship. This will help developers understand the change more easily.

Suggested change
* Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). * **AdyenFees**: All transaction fees due to Adyen. This is the aggregated amount of Adyen\'s commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform\'s or marketplace\'s commission on a transaction. * **DCCPlatformCommission**: **deprecated** The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: The Dynamic Currency Conversion (DCC) fee on a transaction. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user\'s balance account. * **VAT**: The value-added tax charged on the payment.
* Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/). Possible values: * **AcquiringFees**: The acquiring fee (the aggregated amount of interchange and scheme fee) incurred on a transaction. * **AdyenCommission**: The transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing). * **AdyenFees**: All transaction fees due to Adyen. This is the aggregated amount of Adyen\'s commission and markup. * **AdyenMarkup**: The transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing). * **BalanceAccount**: The amount booked to your user after the deduction of the relevant fees. * **Commission**: Your platform\'s or marketplace\'s commission on a transaction. * **DCCPlatformCommission**: **deprecated** Use `DCCMarkup` instead. The Dynamic Currency Conversion (DCC) fee on a transaction. * **DCCMarkup**: The Dynamic Currency Conversion (DCC) fee on a transaction. Replaces the deprecated `DCCPlatformCommission`. * **Interchange**: The interchange fee (fee paid to the issuer) incurred on a transaction. * **PaymentFee**: The aggregated amount of all transaction fees. * **Remainder**: The leftover amount after currency conversion. * **SchemeFee**: The scheme fee incurred on a transaction. * **Surcharge**: The surcharge paid by the customer on a transaction. * **Tip**: The tip paid by the customer. * **TopUp**: An incoming transfer to top up your user\'s balance account. * **VAT**: The value-added tax charged on the payment.

*/
"platformPaymentType"?: PlatformPayment.PlatformPaymentTypeEnum;
/**
Expand Down Expand Up @@ -93,6 +93,7 @@ export namespace PlatformPayment {
BalanceAccount = 'BalanceAccount',
ChargebackRemainder = 'ChargebackRemainder',
Commission = 'Commission',
DccMarkup = 'DCCMarkup',
DccPlatformCommission = 'DCCPlatformCommission',
Default = 'Default',
Interchange = 'Interchange',
Expand Down
2 changes: 1 addition & 1 deletion src/typings/transfers/routingDetails.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export class RoutingDetails {
*/
"errorCode"?: string;
/**
* The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. 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).
* The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. 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).
*/
"priority"?: RoutingDetails.PriorityEnum;
/**
Expand Down
Loading