mirror of
https://github.com/jlengrand/adyen-node-api-library.git
synced 2026-03-10 08:01:20 +00:00
Release v2.2.0
- Update: API type definitions (#176) - Feature: Adds paymentLinks service (#209)
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
[](https://www.npmjs.com/package/@adyen/api-library)
|
||||
[](https://sonarcloud.io/dashboard?id=Adyen_adyen-node-api-library)
|
||||
|
||||
The Adyen API Library for NodeJS enables you to work with Adyen APIs and Hosted Payment Pages.
|
||||
The Adyen API Library for NodeJS enables you to work with Adyen APIs.
|
||||
|
||||
## Integration
|
||||
The Library supports all APIs under the following services:
|
||||
|
||||
@@ -33,5 +33,9 @@ module.exports = {
|
||||
],
|
||||
testMatch: [
|
||||
"**/__tests__/*.ts"
|
||||
],
|
||||
testPathIgnorePatterns : [
|
||||
"/node_modules",
|
||||
"/dist"
|
||||
]
|
||||
};
|
||||
|
||||
2177
package-lock.json
generated
2177
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
42
package.json
42
package.json
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@adyen/api-library",
|
||||
"version": "2.1.8",
|
||||
"description": "The Adyen API Library for NodeJS enables you to work with Adyen APIs and Hosted Payment Pages.",
|
||||
"version": "2.2.0",
|
||||
"description": "The Adyen API Library for NodeJS enables you to work with Adyen APIs.",
|
||||
"main": "dist/lib/src/index.js",
|
||||
"types": "dist/lib/src/index.d.ts",
|
||||
"module": "dist/lib-esm/src/index.js",
|
||||
@@ -38,32 +38,32 @@
|
||||
"author": "Ricardo Ambrogi",
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
"@babel/core": "7.7.2",
|
||||
"@babel/plugin-proposal-class-properties": "7.7.0",
|
||||
"@babel/plugin-proposal-object-rest-spread": "7.6.2",
|
||||
"@babel/plugin-transform-runtime": "7.6.2",
|
||||
"@babel/plugin-transform-typescript": "^7.7.2",
|
||||
"@babel/preset-env": "7.7.1",
|
||||
"@babel/preset-typescript": "^7.7.2",
|
||||
"@babel/runtime": "7.7.2",
|
||||
"@types/jest": "^24.0.23",
|
||||
"@babel/core": "7.7.7",
|
||||
"@babel/plugin-proposal-class-properties": "7.7.4",
|
||||
"@babel/plugin-proposal-object-rest-spread": "7.7.7",
|
||||
"@babel/plugin-transform-runtime": "7.7.6",
|
||||
"@babel/plugin-transform-typescript": "7.7.4",
|
||||
"@babel/preset-env": "7.7.7",
|
||||
"@babel/preset-typescript": "7.7.7",
|
||||
"@babel/runtime": "7.7.7",
|
||||
"@types/jest": "24.0.25",
|
||||
"@types/nock": "10.0.3",
|
||||
"@types/node": "11.15.2",
|
||||
"@typescript-eslint/eslint-plugin": "2.8.0",
|
||||
"@typescript-eslint/parser": "2.8.0",
|
||||
"@types/node": "13.1.4",
|
||||
"@typescript-eslint/eslint-plugin": "2.15.0",
|
||||
"@typescript-eslint/parser": "2.15.0",
|
||||
"babel-loader": "8.0.6",
|
||||
"coveralls": "3.0.8",
|
||||
"eslint": "6.6.0",
|
||||
"coveralls": "3.0.9",
|
||||
"eslint": "6.8.0",
|
||||
"jest": "24.9.0",
|
||||
"nock": "11.7.0",
|
||||
"nock": "11.7.1",
|
||||
"release-it": "12.4.3",
|
||||
"ts-jest": "^24.1.0",
|
||||
"ts-jest": "24.3.0",
|
||||
"ts-loader": "6.2.1",
|
||||
"typescript": "3.7.2",
|
||||
"webpack": "4.41.2",
|
||||
"typescript": "3.7.4",
|
||||
"webpack": "4.41.5",
|
||||
"webpack-cli": "3.3.10"
|
||||
},
|
||||
"dependencies": {
|
||||
"https-proxy-agent": "3.0.1"
|
||||
"https-proxy-agent": "4.0.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -21,7 +21,6 @@
|
||||
import nock from "nock";
|
||||
import {createMockClientFromResponse} from "../__mocks__/base";
|
||||
import BinLookup from "../services/binLookup";
|
||||
import {CostEstimateRequest, ThreeDSAvailabilityRequest} from "../typings/binLookup";
|
||||
import Client from "../client";
|
||||
import HttpClientException from "../httpClient/httpClientException";
|
||||
|
||||
@@ -54,7 +53,7 @@ beforeEach((): void => {
|
||||
|
||||
describe("Bin Lookup", function (): void {
|
||||
it("should succeed on get 3ds availability", async function (): Promise<void> {
|
||||
const threeDSAvailabilityRequest: ThreeDSAvailabilityRequest = {
|
||||
const threeDSAvailabilityRequest: IBinLookup.ThreeDSAvailabilityRequest = {
|
||||
merchantAccount: "MOCK_MERCHANT_ACCOUNT",
|
||||
brands: ["randomBrand"],
|
||||
cardNumber: "4111111111111111"
|
||||
@@ -79,7 +78,7 @@ describe("Bin Lookup", function (): void {
|
||||
.reply(403, JSON.stringify({status: 403, message: "fail", errorCode: "171"}));
|
||||
|
||||
try {
|
||||
await binLookup.get3dsAvailability(threeDSAvailabilityRequest as unknown as ThreeDSAvailabilityRequest);
|
||||
await binLookup.get3dsAvailability(threeDSAvailabilityRequest as unknown as IBinLookup.ThreeDSAvailabilityRequest);
|
||||
fail("Expected request to fail");
|
||||
} catch (e) {
|
||||
expect(e instanceof HttpClientException).toBeTruthy();
|
||||
@@ -92,7 +91,7 @@ describe("Bin Lookup", function (): void {
|
||||
resultCode: "Unsupported",
|
||||
surchargeType: "ZERO"
|
||||
};
|
||||
const costEstimateRequest: CostEstimateRequest = {
|
||||
const costEstimateRequest: IBinLookup.CostEstimateRequest = {
|
||||
amount: { currency: "EUR", value: 1000 },
|
||||
assumptions: {
|
||||
assumeLevel3Data: true,
|
||||
@@ -105,7 +104,7 @@ describe("Bin Lookup", function (): void {
|
||||
mcc: "7411",
|
||||
enrolledIn3DSecure: true
|
||||
},
|
||||
shopperInteraction: CostEstimateRequest.ShopperInteractionEnum.Ecommerce
|
||||
shopperInteraction: "Ecommerce"
|
||||
};
|
||||
|
||||
scope.post("/getCostEstimate")
|
||||
|
||||
@@ -28,26 +28,20 @@ import {paymentSessionSuccess} from "../__mocks__/checkout/paymentSessionSucess"
|
||||
import {paymentsResultMultibancoSuccess} from "../__mocks__/checkout/paymentsResultMultibancoSuccess";
|
||||
import {paymentsResultSuccess} from "../__mocks__/checkout/paymentsResultSucess";
|
||||
import Client from "../client";
|
||||
import { TYPE_SCHEME } from "../typings/constants/apiConstants";
|
||||
import Checkout from "../services/checkout";
|
||||
import {
|
||||
Amount,
|
||||
DetailsRequest,
|
||||
PaymentMethodsRequest,
|
||||
PaymentRequest,
|
||||
PaymentResponse,
|
||||
PaymentSetupRequest, PaymentVerificationRequest
|
||||
} from "../typings/checkout";
|
||||
import HttpClientException from "../httpClient/httpClientException";
|
||||
|
||||
function createAmountObject(currency: string, value: number): Amount {
|
||||
const merchantAccount = "MagentoMerchantTest";
|
||||
const reference = "Your order number";
|
||||
|
||||
function createAmountObject(currency: string, value: number): ICheckout.Amount {
|
||||
return {
|
||||
currency,
|
||||
value,
|
||||
};
|
||||
}
|
||||
|
||||
function createPaymentsDetailsRequest(): DetailsRequest {
|
||||
function createPaymentsDetailsRequest(): ICheckout.DetailsRequest {
|
||||
return {
|
||||
details: {
|
||||
MD: "mdValue",
|
||||
@@ -57,31 +51,31 @@ function createPaymentsDetailsRequest(): DetailsRequest {
|
||||
};
|
||||
}
|
||||
|
||||
export function createPaymentsCheckoutRequest(): PaymentRequest {
|
||||
export function createPaymentsCheckoutRequest(): ICheckout.PaymentRequest {
|
||||
const paymentMethodDetails = {
|
||||
cvc: "737",
|
||||
expiryMonth: "10",
|
||||
expiryYear: "2018",
|
||||
holderName: "John Smith",
|
||||
number: "4111111111111111",
|
||||
type: TYPE_SCHEME,
|
||||
type: "scheme",
|
||||
};
|
||||
|
||||
return {
|
||||
amount: createAmountObject("USD", 1000),
|
||||
merchantAccount: "MagentoMerchantTest",
|
||||
merchantAccount,
|
||||
paymentMethod: paymentMethodDetails,
|
||||
reference: "Your order number",
|
||||
reference,
|
||||
returnUrl: "https://your-company.com/...",
|
||||
};
|
||||
}
|
||||
|
||||
function createPaymentSessionRequest(): PaymentSetupRequest {
|
||||
function createPaymentSessionRequest(): ICheckout.PaymentSetupRequest {
|
||||
return {
|
||||
amount: createAmountObject("USD", 1000),
|
||||
countryCode: "NL",
|
||||
merchantAccount: "MagentoMerchantTest",
|
||||
reference: "Your order number",
|
||||
merchantAccount,
|
||||
reference,
|
||||
returnUrl: "https://your-company.com/...",
|
||||
};
|
||||
}
|
||||
@@ -101,8 +95,8 @@ describe("Checkout", (): void => {
|
||||
scope.post("/payments")
|
||||
.reply(200, paymentsSuccess);
|
||||
|
||||
const paymentsRequest: PaymentRequest = createPaymentsCheckoutRequest();
|
||||
const paymentsResponse: PaymentResponse = await checkout.payments(paymentsRequest);
|
||||
const paymentsRequest: ICheckout.PaymentRequest = createPaymentsCheckoutRequest();
|
||||
const paymentsResponse: ICheckout.PaymentResponse = await checkout.payments(paymentsRequest);
|
||||
expect(paymentsResponse.pspReference).toEqual("8535296650153317");
|
||||
});
|
||||
|
||||
@@ -111,7 +105,7 @@ describe("Checkout", (): void => {
|
||||
scope.post("/payments")
|
||||
.reply(401);
|
||||
|
||||
const paymentsRequest: PaymentRequest = createPaymentsCheckoutRequest();
|
||||
const paymentsRequest: ICheckout.PaymentRequest = createPaymentsCheckoutRequest();
|
||||
await checkout.payments(paymentsRequest);
|
||||
} catch (e) {
|
||||
expect(e instanceof HttpClientException).toBeTruthy();
|
||||
@@ -119,7 +113,7 @@ describe("Checkout", (): void => {
|
||||
});
|
||||
|
||||
it("should have valid payment methods", async (): Promise<void> => {
|
||||
const paymentMethodsRequest: PaymentMethodsRequest = {merchantAccount: "MagentoMerchantTest"};
|
||||
const paymentMethodsRequest: ICheckout.PaymentMethodsRequest = {merchantAccount: "MagentoMerchantTest"};
|
||||
|
||||
scope.post("/paymentMethods")
|
||||
.reply(200, paymentMethodsSuccess);
|
||||
@@ -133,6 +127,50 @@ describe("Checkout", (): void => {
|
||||
}
|
||||
});
|
||||
|
||||
it("should have valid payment link", async (): Promise<void> => {
|
||||
const amount = createAmountObject("BRL", 1000);
|
||||
const expiresAt = "2019-12-17T10:05:29Z";
|
||||
const paymentLinkRequest: ICheckout.CreatePaymentLinkRequest = {
|
||||
allowedPaymentMethods: ["scheme", "boletobancario"],
|
||||
amount,
|
||||
countryCode: "BR",
|
||||
merchantAccount,
|
||||
shopperReference: "shopperReference",
|
||||
shopperEmail: "test@email.com",
|
||||
shopperLocale: "pt_BR",
|
||||
billingAddress: {
|
||||
street: "Roque Petroni Jr",
|
||||
postalCode: "59000060",
|
||||
city: "São Paulo",
|
||||
houseNumberOrName: "999",
|
||||
country: "BR",
|
||||
stateOrProvince: "SP"
|
||||
},
|
||||
deliveryAddress: {
|
||||
street: "Roque Petroni Jr",
|
||||
postalCode: "59000060",
|
||||
city: "São Paulo",
|
||||
houseNumberOrName: "999",
|
||||
country: "BR",
|
||||
stateOrProvince: "SP"
|
||||
},
|
||||
expiresAt,
|
||||
reference
|
||||
};
|
||||
|
||||
const paymentLinkSuccess: ICheckout.CreatePaymentLinkResponse = {
|
||||
amount,
|
||||
expiresAt,
|
||||
reference,
|
||||
url: "paymentLinkResponse.url"
|
||||
};
|
||||
|
||||
scope.post("/paymentLinks").reply(200, paymentLinkSuccess);
|
||||
|
||||
const paymentSuccessLinkResponse = await checkout.paymentLinks(paymentLinkRequest);
|
||||
expect(paymentLinkSuccess).toEqual(paymentSuccessLinkResponse);
|
||||
});
|
||||
|
||||
it("should have payment details", async (): Promise<void> => {
|
||||
scope.post("/payments/details")
|
||||
.reply(200, paymentDetailsSuccess);
|
||||
@@ -146,7 +184,7 @@ describe("Checkout", (): void => {
|
||||
scope.post("/paymentSession")
|
||||
.reply(200, paymentSessionSuccess);
|
||||
const checkout: Checkout = new Checkout(client);
|
||||
const paymentSessionRequest: PaymentSetupRequest = createPaymentSessionRequest();
|
||||
const paymentSessionRequest: ICheckout.PaymentSetupRequest = createPaymentSessionRequest();
|
||||
const paymentSessionResponse = await checkout.paymentSession(paymentSessionRequest);
|
||||
expect(paymentSessionResponse.paymentSession).not.toBeUndefined();
|
||||
});
|
||||
@@ -156,7 +194,7 @@ describe("Checkout", (): void => {
|
||||
scope.post("/payments/result")
|
||||
.reply(200, paymentsResultSuccess);
|
||||
const checkout = new Checkout(client);
|
||||
const paymentResultRequest: PaymentVerificationRequest = {
|
||||
const paymentResultRequest: ICheckout.PaymentVerificationRequest = {
|
||||
payload: "This is a test payload",
|
||||
};
|
||||
const paymentResultResponse = await checkout.paymentResult(paymentResultRequest);
|
||||
@@ -180,8 +218,8 @@ describe("Checkout", (): void => {
|
||||
.reply(200, paymentsResultMultibancoSuccess);
|
||||
|
||||
const checkout: Checkout = new Checkout(client);
|
||||
const paymentsRequest: PaymentRequest = createPaymentsCheckoutRequest();
|
||||
const paymentsResponse: PaymentResponse = await checkout.payments(paymentsRequest);
|
||||
const paymentsRequest: ICheckout.PaymentRequest = createPaymentsCheckoutRequest();
|
||||
const paymentsResponse: ICheckout.PaymentResponse = await checkout.payments(paymentsRequest);
|
||||
expect(paymentsResponse.pspReference).toEqual("8111111111111111");
|
||||
|
||||
if (paymentsResponse.additionalData) {
|
||||
|
||||
@@ -23,14 +23,13 @@ import nock from "nock";
|
||||
import { createMockClientFromResponse } from "../__mocks__/base";
|
||||
import {originKeysSuccess} from "../__mocks__/checkoutUtility/originkeysSuccess";
|
||||
import CheckoutUtility from "../services/checkoutUtility";
|
||||
import {CheckoutUtilityRequest} from "../typings/checkoutUtility";
|
||||
import Client from "../client";
|
||||
|
||||
describe("Checkout Utility", (): void => {
|
||||
it("should get origin keys", async (): Promise<void> => {
|
||||
const client = createMockClientFromResponse();
|
||||
const checkoutUtility = new CheckoutUtility(client);
|
||||
const originKeysRequest: CheckoutUtilityRequest = {
|
||||
const originKeysRequest: ICheckoutUtility.CheckoutUtilityRequest = {
|
||||
originDomains: ["www.test.com", "https://www.your-domain2.com"],
|
||||
};
|
||||
|
||||
@@ -39,7 +38,10 @@ describe("Checkout Utility", (): void => {
|
||||
.reply(200, originKeysSuccess);
|
||||
|
||||
const originKeysResponse = await checkoutUtility.originKeys(originKeysRequest);
|
||||
expect(originKeysResponse.originKeys["https://www.your-domain1.com"])
|
||||
.toEqual("pub.v2.7814286629520534.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.UEwIBmW9-c_uXo5wSEr2w8Hz8hVIpujXPHjpcEse3xI");
|
||||
if (originKeysResponse.originKeys) {
|
||||
return expect(originKeysResponse.originKeys["https://www.your-domain1.com"])
|
||||
.toEqual("pub.v2.7814286629520534.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.UEwIBmW9-c_uXo5wSEr2w8Hz8hVIpujXPHjpcEse3xI");
|
||||
}
|
||||
fail("Error: originKeysResponse.originKeys is empty");
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import HmacValidator from "../utils/hmacValidator";
|
||||
import {NotificationRequestItem} from "../typings/notification";
|
||||
import {HMAC_SIGNATURE} from "../typings/constants/apiConstants";
|
||||
import {ApiConstants} from "../constants/apiConstants";
|
||||
|
||||
const key = "DFB1EB5485895CFA84146406857104ABB4CBCABDC8AAF103A624C8F6A3EAAB00";
|
||||
const expectedSign = "ipnxGCaUZ4l8TUW75a71/ghd2Fe5ffvX0pV4TLTntIc=";
|
||||
@@ -15,7 +15,7 @@ const notificationRequestItem: NotificationRequestItem = {
|
||||
paymentMethod: "VISA",
|
||||
reason: "reason",
|
||||
success: "true",
|
||||
additionalData: { [HMAC_SIGNATURE]: expectedSign },
|
||||
additionalData: { [ApiConstants.HMAC_SIGNATURE]: expectedSign },
|
||||
};
|
||||
|
||||
describe("HMAC Validator", function (): void {
|
||||
@@ -52,7 +52,7 @@ describe("HMAC Validator", function (): void {
|
||||
it("should have invalid hmac", function (): void {
|
||||
const invalidNotification = {
|
||||
...notificationRequestItem,
|
||||
additionalData: { [HMAC_SIGNATURE]: "notValidSign" }
|
||||
additionalData: { [ApiConstants.HMAC_SIGNATURE]: "notValidSign" }
|
||||
};
|
||||
const hmacValidator = new HmacValidator();
|
||||
const result = hmacValidator.validateHMAC(invalidNotification, key);
|
||||
|
||||
@@ -4,7 +4,6 @@ import Checkout from "../services/checkout";
|
||||
import ApiException from "../services/exception/apiException";
|
||||
import {createPaymentsCheckoutRequest} from "./checkout.spec";
|
||||
import HttpClientException from "../httpClient/httpClientException";
|
||||
import {Environment} from "../typings/enums/environment";
|
||||
|
||||
beforeEach((): void => {
|
||||
nock.cleanAll();
|
||||
|
||||
@@ -1,16 +1,9 @@
|
||||
import nock from "nock";
|
||||
import {createMockClientFromResponse} from "../__mocks__/base";
|
||||
import Payout from "../services/payout";
|
||||
import {
|
||||
ModifyRequest,
|
||||
PayoutRequest,
|
||||
Recurring,
|
||||
StoreDetailAndSubmitRequest,
|
||||
StoreDetailRequest,
|
||||
SubmitRequest
|
||||
} from "../typings/payout";
|
||||
import {FRAUD_MANUAL_REVIEW, FRAUD_RESULT_TYPE} from "../typings/constants/apiConstants";
|
||||
import Client from "../client";
|
||||
import StoreDetailRequest = IPayouts.StoreDetailRequest;
|
||||
import {ApiConstants} from "../constants/apiConstants";
|
||||
|
||||
const storeDetailAndSubmitThirdParty = JSON.stringify({
|
||||
additionalData: {
|
||||
@@ -38,37 +31,37 @@ const amountAndReference = {
|
||||
};
|
||||
|
||||
const defaultData = {
|
||||
dateOfBirth: new Date(),
|
||||
dateOfBirth: (new Date()).toISOString(),
|
||||
nationality: "NL",
|
||||
shopperEmail: "johndoe@email.com",
|
||||
shopperReference: "shopperReference",
|
||||
};
|
||||
|
||||
const mockStoreDetailRequest = (merchantAccount: string): StoreDetailRequest => ({
|
||||
const mockStoreDetailRequest = (merchantAccount: string): IPayouts.StoreDetailRequest => ({
|
||||
...defaultData,
|
||||
entityType: StoreDetailRequest.EntityTypeEnum.NaturalPerson,
|
||||
entityType: "NaturalPerson",
|
||||
recurring: {
|
||||
contract: Recurring.ContractEnum.ONECLICK
|
||||
contract: "ONECLICK"
|
||||
},
|
||||
merchantAccount,
|
||||
});
|
||||
|
||||
const mockSubmitRequest = (merchantAccount: string): SubmitRequest => ({
|
||||
const mockSubmitRequest = (merchantAccount: string): IPayouts.SubmitRequest => ({
|
||||
selectedRecurringDetailReference: "LATEST",
|
||||
recurring: {
|
||||
contract: Recurring.ContractEnum.ONECLICK
|
||||
contract: "ONECLICK"
|
||||
},
|
||||
...defaultData,
|
||||
...amountAndReference,
|
||||
merchantAccount,
|
||||
});
|
||||
|
||||
const mockStoreDetailAndSubmitRequest = (merchantAccount: string): StoreDetailAndSubmitRequest => ({
|
||||
const mockStoreDetailAndSubmitRequest = (merchantAccount: string): IPayouts.StoreDetailAndSubmitRequest => ({
|
||||
...amountAndReference,
|
||||
...(mockStoreDetailRequest(merchantAccount)),
|
||||
});
|
||||
|
||||
const mockPayoutRequest = (merchantAccount: string): PayoutRequest => ({
|
||||
const mockPayoutRequest = (merchantAccount: string): IPayouts.PayoutRequest => ({
|
||||
...amountAndReference,
|
||||
...defaultData,
|
||||
card: {
|
||||
@@ -92,7 +85,7 @@ beforeEach((): void => {
|
||||
|
||||
describe("PayoutTest", function (): void {
|
||||
it("should succeed on store detail and submit third party", async function (): Promise<void> {
|
||||
const request: StoreDetailAndSubmitRequest = mockStoreDetailAndSubmitRequest(`${client.config.merchantAccount}`);
|
||||
const request: IPayouts.StoreDetailAndSubmitRequest = mockStoreDetailAndSubmitRequest(`${client.config.merchantAccount}`);
|
||||
scope.post("/storeDetail").reply(200, storeDetailAndSubmitThirdParty);
|
||||
|
||||
const result = await payout.storeDetail(request);
|
||||
@@ -100,8 +93,8 @@ describe("PayoutTest", function (): void {
|
||||
expect(result.pspReference).toEqual("8515131751004933");
|
||||
|
||||
if (result.additionalData) {
|
||||
expect(result.additionalData[FRAUD_RESULT_TYPE]).toEqual("GREEN");
|
||||
expect(result.additionalData[FRAUD_MANUAL_REVIEW]).toEqual("false");
|
||||
expect(result.additionalData[ApiConstants.FRAUD_RESULT_TYPE]).toEqual("GREEN");
|
||||
expect(result.additionalData[ApiConstants.FRAUD_MANUAL_REVIEW]).toEqual("false");
|
||||
}
|
||||
});
|
||||
|
||||
@@ -122,7 +115,7 @@ describe("PayoutTest", function (): void {
|
||||
response: "[payout-confirm-received]"
|
||||
});
|
||||
|
||||
const request: ModifyRequest = {
|
||||
const request: IPayouts.ModifyRequest = {
|
||||
merchantAccount: "MOCKED_MERCHANT_ACCOUNT",
|
||||
originalReference: "reference"
|
||||
};
|
||||
@@ -135,15 +128,15 @@ describe("PayoutTest", function (): void {
|
||||
it("should succeed on submit third party", async function (): Promise<void> {
|
||||
scope.post("/submitThirdParty").reply(200, storeDetailAndSubmitThirdParty);
|
||||
|
||||
const request: SubmitRequest = mockSubmitRequest("MOCKED_MERCHANT_ACC");
|
||||
const request: IPayouts.SubmitRequest = mockSubmitRequest("MOCKED_MERCHANT_ACC");
|
||||
const result = await payout.submitThirdparty(request);
|
||||
|
||||
expect(result.resultCode).toEqual("[payout-submit-received]");
|
||||
expect(result.pspReference).toEqual("8515131751004933");
|
||||
|
||||
if (result.additionalData) {
|
||||
expect(result.additionalData[FRAUD_RESULT_TYPE]).toEqual("GREEN");
|
||||
expect(result.additionalData[FRAUD_MANUAL_REVIEW]).toEqual("false");
|
||||
expect(result.additionalData[ApiConstants.FRAUD_RESULT_TYPE]).toEqual("GREEN");
|
||||
expect(result.additionalData[ApiConstants.FRAUD_MANUAL_REVIEW]).toEqual("false");
|
||||
}
|
||||
});
|
||||
|
||||
@@ -153,7 +146,7 @@ describe("PayoutTest", function (): void {
|
||||
response: "[payout-confirm-received]"
|
||||
});
|
||||
|
||||
const request: ModifyRequest = {
|
||||
const request: IPayouts.ModifyRequest = {
|
||||
merchantAccount: "MOCKED_MERCHANT_ACC",
|
||||
originalReference: "reference"
|
||||
};
|
||||
|
||||
@@ -2,15 +2,13 @@ import nock from "nock";
|
||||
import {createMockClientFromResponse} from "../__mocks__/base";
|
||||
import {disableSuccess} from "../__mocks__/recurring/disableSuccess";
|
||||
import {listRecurringDetailsSuccess} from "../__mocks__/recurring/listRecurringDetailsSuccess";
|
||||
import {DisableRequest, Recurring as RecurringType } from "../typings/recurring";
|
||||
import Recurring from "../services/recurring";
|
||||
import { RecurringDetailsRequest } from "../typings/recurring/recurringDetailsRequest";
|
||||
import Client from "../client";
|
||||
|
||||
const createRecurringDetailsRequest = (): RecurringDetailsRequest => {
|
||||
const createRecurringDetailsRequest = (): IRecurring.RecurringDetailsRequest => {
|
||||
return {
|
||||
merchantAccount: "MerchantAccount",
|
||||
recurring: { contract: RecurringType.ContractEnum.ONECLICK },
|
||||
recurring: { contract: "ONECLICK" },
|
||||
shopperReference: "test-123",
|
||||
};
|
||||
};
|
||||
@@ -39,7 +37,7 @@ describe("Recurring", (): void => {
|
||||
scope.post("/disable")
|
||||
.reply(200, disableSuccess);
|
||||
|
||||
const request: DisableRequest = {
|
||||
const request: IRecurring.DisableRequest = {
|
||||
merchantAccount: "MerchantAccount",
|
||||
recurringDetailReference: "reference",
|
||||
shopperReference: "test-123",
|
||||
|
||||
@@ -20,10 +20,9 @@
|
||||
*/
|
||||
|
||||
import Config from "./config";
|
||||
import ClientInterface from "./typings/httpClient/clientInterface";
|
||||
import HttpURLConnectionClient from "./httpClient/httpURLConnectionClient";
|
||||
import { Environment } from "./typings/enums/environment";
|
||||
import {version} from "../package.json";
|
||||
import ClientInterface from "./httpClient/clientInterface";
|
||||
|
||||
type ClientParametersOverload =
|
||||
| { config: Config }
|
||||
@@ -55,18 +54,18 @@ class Client {
|
||||
public static HPP_LIVE = "https://live.adyen.com/hpp";
|
||||
public static MARKETPAY_ENDPOINT_TEST = "https://cal-test.adyen.com/cal/services";
|
||||
public static MARKETPAY_ENDPOINT_LIVE = "https://cal-live.adyen.com/cal/services";
|
||||
public static API_VERSION = "v49";
|
||||
public static RECURRING_API_VERSION = "v30";
|
||||
public static MARKETPAY_ACCOUNT_API_VERSION = "v4";
|
||||
public static MARKETPAY_FUND_API_VERSION = "v3";
|
||||
public static MARKETPAY_NOTIFICATION_API_VERSION = "v1";
|
||||
public static API_VERSION = "v51";
|
||||
public static RECURRING_API_VERSION = "v49";
|
||||
public static MARKETPAY_ACCOUNT_API_VERSION = "v5";
|
||||
public static MARKETPAY_FUND_API_VERSION = "v5";
|
||||
public static MARKETPAY_NOTIFICATION_API_VERSION = "v5";
|
||||
public static LIB_NAME = "adyen-node-api-library";
|
||||
public static LIB_VERSION: string = version;
|
||||
public static CHECKOUT_ENDPOINT_TEST = "https://checkout-test.adyen.com/checkout";
|
||||
public static CHECKOUT_ENDPOINT_LIVE_SUFFIX = "-checkout-live.adyenpayments.com/checkout";
|
||||
public static CHECKOUT_API_VERSION = "v49";
|
||||
public static CHECKOUT_API_VERSION = "v51";
|
||||
public static BIN_LOOKUP_PAL_SUFFIX = "/pal/servlet/BinLookup/";
|
||||
public static BIN_LOOKUP_API_VERSION = "v40";
|
||||
public static BIN_LOOKUP_API_VERSION = "v50";
|
||||
public static CHECKOUT_UTILITY_API_VERSION = "v1";
|
||||
public static TERMINAL_API_ENDPOINT_TEST = "https://terminal-api-test.adyen.com";
|
||||
public static TERMINAL_API_ENDPOINT_LIVE = "https://terminal-api-live.adyen.com";
|
||||
|
||||
@@ -18,8 +18,6 @@
|
||||
* This file is open source and available under the MIT license.
|
||||
* See the LICENSE file for more info.
|
||||
*/
|
||||
import { Environment } from "./typings/enums/environment";
|
||||
|
||||
interface ConfigConstructor {
|
||||
username?: string;
|
||||
password?: string;
|
||||
|
||||
85
src/constants/apiConstants.ts
Normal file
85
src/constants/apiConstants.ts
Normal file
@@ -0,0 +1,85 @@
|
||||
/*
|
||||
* ######
|
||||
* ######
|
||||
* ############ ####( ###### #####. ###### ############ ############
|
||||
* ############# #####( ###### #####. ###### ############# #############
|
||||
* ###### #####( ###### #####. ###### ##### ###### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ######
|
||||
* ############# ############# ############# ############# ##### ######
|
||||
* ############ ############ ############# ############ ##### ######
|
||||
* ######
|
||||
* #############
|
||||
* ############
|
||||
*
|
||||
* Adyen NodeJS API Library
|
||||
*
|
||||
* Copyright (c) 2019 Adyen B.V.
|
||||
* This file is open source and available under the MIT license.
|
||||
* See the LICENSE file for more info.
|
||||
*/
|
||||
|
||||
export enum ApiConstants {
|
||||
TRANSACTION_NOT_PERMITTED = "Transaction Not Permitted",
|
||||
CVC_DECLINED = "CVC Declined",
|
||||
RESTRICTED_CARD = "Restricted Card",
|
||||
PAYMENT_DETAIL_NOT_FOUND = "803 PaymentDetail not found",
|
||||
REFUSED = "Refused",
|
||||
|
||||
REFUSAL_REASON_RAW = "refusalReasonRaw",
|
||||
PAYMENT_METHOD = "paymentMethod",
|
||||
EXPIRY_DATE = "expiryDate",
|
||||
CARD_BIN = "cardBin",
|
||||
CARD_HOLDER_NAME = "cardHolderName",
|
||||
CARD_SUMMARY = "cardSummary",
|
||||
THREE_D_OFFERERED = "threeDOffered",
|
||||
THREE_D_AUTHENTICATED = "threeDAuthenticated",
|
||||
AVS_RESULT = "avsResult",
|
||||
PAYMENT_TOKEN = "payment.token",
|
||||
FRAUD_RESULT_TYPE = "fraudResultType",
|
||||
FRAUD_MANUAL_REVIEW = "fraudManualReview",
|
||||
AUTH_CODE = "authCode",
|
||||
|
||||
BOLETO_BARCODE_REFERENCE = "boletobancario.barCodeReference",
|
||||
BOLETO_DATA = "boletobancario.data",
|
||||
BOLETO_DUE_DATE = "boletobancario.dueDate",
|
||||
BOLETO_URL = "boletobancario.url",
|
||||
BOLETO_EXPIRATION_DATE = "boletobancario.expirationDate",
|
||||
|
||||
MULTIBANCO_ENTITY = "comprafacil.entity",
|
||||
MULTIBANCO_AMOUNT = "comprafacil.amount",
|
||||
MULTIBANCO_DEADLINE = "comprafacil.deadline",
|
||||
MULTIBANCO_REFERENCE = "comprafacil.reference",
|
||||
|
||||
HMAC_SIGNATURE = "hmacSignature",
|
||||
|
||||
JSON = "card.encrypted.json",
|
||||
|
||||
BOLETO_SANTANDER = "boletobancario_santander",
|
||||
|
||||
NUMBER = "number",
|
||||
EXPIRY_MONTH = "expiryMonth",
|
||||
EXPIRY_YEAR = "expiryYear",
|
||||
CVC = "cvc",
|
||||
ENCRYPTED_CARD_NUMBER = "encryptedCardNumber",
|
||||
ENCRYPTED_EXPIRY_MONTH = "encryptedExpiryMonth",
|
||||
ENCRYPTED_EXPIRY_YEAR = "encryptedExpiryYear",
|
||||
ENCRYPTED_SECURITY_CODE = "encryptedSecurityCode",
|
||||
METHOD_TYPE = "type",
|
||||
HOLDER_NAME = "holderName",
|
||||
RECURRING_DETAIL_REFERENCE = "recurringDetailReference",
|
||||
STORE_DETAILS = "storeDetails",
|
||||
|
||||
MD = "MD",
|
||||
PAREQ = "PaReq",
|
||||
|
||||
TYPE_SCHEME = "scheme",
|
||||
|
||||
IDEMPOTENCY_KEY = "Idempotency-Key",
|
||||
ACCEPT_CHARSET = "Accept-Charset",
|
||||
USER_AGENT = "User-Agent",
|
||||
METHOD_POST = "POST",
|
||||
CONTENT_TYPE = "Content-Type",
|
||||
API_KEY = "X-API-Key",
|
||||
APPLICATION_JSON_TYPE = "application/json",
|
||||
}
|
||||
@@ -19,6 +19,8 @@
|
||||
* See the LICENSE file for more info.
|
||||
*/
|
||||
|
||||
export const NEXO_HMAC_KEY_LENGTH = 32;
|
||||
export const NEXO_CIPHER_KEY_LENGTH = 32;
|
||||
export const NEXO_IV_LENGTH = 16;
|
||||
export enum NexoEnum {
|
||||
HMAC_KEY_LENGTH = 32,
|
||||
CIPHER_KEY_LENGTH = 32,
|
||||
IV_LENGTH = 16
|
||||
}
|
||||
@@ -20,17 +20,16 @@
|
||||
*/
|
||||
|
||||
import Resource from "../services/resource";
|
||||
import { RequestOptions } from "../typings/requestOptions";
|
||||
import HttpClientException from "../httpClient/httpClientException";
|
||||
import ApiException from "../services/exception/apiException";
|
||||
|
||||
async function getJsonResponse<T>(resource: Resource, jsonRequest: T | string, requestOptions?: RequestOptions): Promise<string>;
|
||||
async function getJsonResponse<T, R>(resource: Resource, jsonRequest: T | string, requestOptions?: RequestOptions): Promise<R>;
|
||||
async function getJsonResponse<T>(resource: Resource, jsonRequest: T | string, requestOptions?: IRequest.Options): Promise<string>;
|
||||
async function getJsonResponse<T, R>(resource: Resource, jsonRequest: T | string, requestOptions?: IRequest.Options): Promise<R>;
|
||||
|
||||
async function getJsonResponse<T, R>(
|
||||
resource: Resource,
|
||||
jsonRequest: T | string,
|
||||
requestOptions: RequestOptions = {},
|
||||
requestOptions: IRequest.Options = {},
|
||||
): Promise<R | string | HttpClientException | ApiException> {
|
||||
const request = typeof jsonRequest === "string" ? jsonRequest : JSON.stringify(jsonRequest);
|
||||
const response = await resource.request(request, requestOptions);
|
||||
|
||||
@@ -18,15 +18,14 @@
|
||||
* This file is open source and available under the MIT license.
|
||||
* See the LICENSE file for more info.
|
||||
*/
|
||||
import Config from "../../config";
|
||||
import { RequestOptions } from "../requestOptions";
|
||||
import { AgentOptions } from "https";
|
||||
import HttpClientException from "../../httpClient/httpClientException";
|
||||
import ApiException from "../../services/exception/apiException";
|
||||
import HttpClientException from "./httpClientException";
|
||||
import ApiException from "../services/exception/apiException";
|
||||
import {Config} from "../index";
|
||||
|
||||
interface ClientInterface {
|
||||
request(
|
||||
endpoint: string, json: string, config: Config, isApiKeyRequired: boolean, requestOptions?: RequestOptions,
|
||||
endpoint: string, json: string, config: Config, isApiKeyRequired: boolean, requestOptions?: IRequest.Options,
|
||||
): Promise<string | HttpClientException | ApiException>;
|
||||
post(endpoint: string, postParameters: [string, string][], config: Config): Promise<HttpClientException | string>;
|
||||
proxy?: AgentOptions;
|
||||
@@ -27,21 +27,12 @@ import * as fs from "fs";
|
||||
import {URL} from "url";
|
||||
import Client from "../client";
|
||||
import Config from "../config";
|
||||
import {
|
||||
ACCEPT_CHARSET,
|
||||
API_KEY,
|
||||
APPLICATION_JSON_TYPE,
|
||||
CONTENT_TYPE,
|
||||
IDEMPOTENCY_KEY,
|
||||
METHOD_POST,
|
||||
USER_AGENT,
|
||||
} from "../typings/constants/apiConstants";
|
||||
import { RequestOptions } from "../typings/requestOptions";
|
||||
import ClientInterface from "../typings/httpClient/clientInterface";
|
||||
import HttpClientException from "./httpClientException";
|
||||
import checkServerIdentity from "../helpers/checkServerIdentity";
|
||||
import {ApiError} from "../typings/apiError";
|
||||
import ApiException from "../services/exception/apiException";
|
||||
import ClientInterface from "./clientInterface";
|
||||
import {ApiConstants} from "../constants/apiConstants";
|
||||
|
||||
class HttpURLConnectionClient implements ClientInterface {
|
||||
private static CHARSET = "utf-8";
|
||||
@@ -50,7 +41,7 @@ class HttpURLConnectionClient implements ClientInterface {
|
||||
|
||||
public request(
|
||||
endpoint: string, json: string, config: Config, isApiRequired: boolean,
|
||||
requestOptions: RequestOptions,
|
||||
requestOptions: IRequest.Options,
|
||||
): Promise<string | HttpClientException | ApiException> {
|
||||
requestOptions.headers = {};
|
||||
requestOptions.timeout = config.connectionTimeoutMillis;
|
||||
@@ -66,7 +57,7 @@ class HttpURLConnectionClient implements ClientInterface {
|
||||
}
|
||||
|
||||
if (apiKey) {
|
||||
requestOptions.headers[API_KEY] = apiKey;
|
||||
requestOptions.headers[ApiConstants.API_KEY] = apiKey;
|
||||
} else {
|
||||
const authString = `${config.username}:${config.password}`;
|
||||
const authStringEnc = new Buffer(authString).toString("base64");
|
||||
@@ -74,7 +65,7 @@ class HttpURLConnectionClient implements ClientInterface {
|
||||
requestOptions.headers.Authorization = `Basic ${authStringEnc}`;
|
||||
}
|
||||
|
||||
requestOptions.headers[CONTENT_TYPE] = APPLICATION_JSON_TYPE;
|
||||
requestOptions.headers[ApiConstants.CONTENT_TYPE] = ApiConstants.APPLICATION_JSON_TYPE;
|
||||
|
||||
const httpConnection: ClientRequest = this.createRequest(endpoint, requestOptions, config.applicationName);
|
||||
return this.doPostRequest(httpConnection, json);
|
||||
@@ -86,7 +77,7 @@ class HttpURLConnectionClient implements ClientInterface {
|
||||
return this.doPostRequest(connectionRequest, postQuery);
|
||||
}
|
||||
|
||||
private createRequest(endpoint: string, requestOptions: RequestOptions, applicationName?: string): ClientRequest {
|
||||
private createRequest(endpoint: string, requestOptions: IRequest.Options, applicationName?: string): ClientRequest {
|
||||
if (!requestOptions.headers) {
|
||||
requestOptions.headers = {};
|
||||
}
|
||||
@@ -98,7 +89,7 @@ class HttpURLConnectionClient implements ClientInterface {
|
||||
requestOptions.path = url.pathname;
|
||||
|
||||
if (requestOptions && requestOptions.idempotencyKey) {
|
||||
requestOptions.headers[IDEMPOTENCY_KEY] = requestOptions.idempotencyKey;
|
||||
requestOptions.headers[ApiConstants.IDEMPOTENCY_KEY] = requestOptions.idempotencyKey;
|
||||
delete requestOptions.idempotencyKey;
|
||||
}
|
||||
|
||||
@@ -110,9 +101,9 @@ class HttpURLConnectionClient implements ClientInterface {
|
||||
}
|
||||
|
||||
requestOptions.headers["Cache-Control"] = "no-cache";
|
||||
requestOptions.method = METHOD_POST;
|
||||
requestOptions.headers[ACCEPT_CHARSET] = HttpURLConnectionClient.CHARSET;
|
||||
requestOptions.headers[USER_AGENT] = `${applicationName} ${Client.LIB_NAME}/${Client.LIB_VERSION}`;
|
||||
requestOptions.method = ApiConstants.METHOD_POST;
|
||||
requestOptions.headers[ApiConstants.ACCEPT_CHARSET] = HttpURLConnectionClient.CHARSET;
|
||||
requestOptions.headers[ApiConstants.USER_AGENT] = `${applicationName} ${Client.LIB_NAME}/${Client.LIB_VERSION}`;
|
||||
|
||||
return httpsRequest(requestOptions);
|
||||
}
|
||||
|
||||
@@ -21,7 +21,6 @@
|
||||
|
||||
import {Cipher, createCipheriv, createDecipheriv, createHmac, randomBytes} from "crypto";
|
||||
import NexoCryptoException from "../services/exception/nexoCryptoException";
|
||||
import {NEXO_IV_LENGTH} from "../typings/constants/nexoConstants";
|
||||
import {
|
||||
MessageHeader,
|
||||
NexoDerivedKey,
|
||||
@@ -31,6 +30,7 @@ import {
|
||||
} from "../typings/terminal";
|
||||
import InvalidSecurityKeyException from "./exception/invalidSecurityKeyException";
|
||||
import NexoDerivedKeyGenerator from "./nexoDerivedKeyGenerator";
|
||||
import {NexoEnum} from "../constants/nexoConstants";
|
||||
|
||||
enum Modes {
|
||||
ENCRYPT,
|
||||
@@ -91,8 +91,8 @@ class NexoCrypto {
|
||||
}
|
||||
|
||||
private static crypt(bytes: Buffer, dk: NexoDerivedKey, ivNonce: Buffer, mode: Modes): Buffer {
|
||||
const actualIV = Buffer.alloc(NEXO_IV_LENGTH);
|
||||
for (let i = 0; i < NEXO_IV_LENGTH; i++) {
|
||||
const actualIV = Buffer.alloc(NexoEnum.IV_LENGTH);
|
||||
for (let i = 0; i < NexoEnum.IV_LENGTH; i++) {
|
||||
actualIV[i] = dk.iv[i] ^ ivNonce[i];
|
||||
}
|
||||
|
||||
@@ -111,7 +111,7 @@ class NexoCrypto {
|
||||
}
|
||||
|
||||
private static generateRandomIvNonce(): Buffer {
|
||||
return randomBytes(NEXO_IV_LENGTH);
|
||||
return randomBytes(NexoEnum.IV_LENGTH);
|
||||
}
|
||||
|
||||
private validateHmac(receivedHmac: Buffer, decryptedMessage: Buffer, derivedKey: NexoDerivedKey): void {
|
||||
|
||||
@@ -20,26 +20,26 @@
|
||||
*/
|
||||
|
||||
import {pbkdf2Sync} from "crypto";
|
||||
import {NEXO_CIPHER_KEY_LENGTH, NEXO_HMAC_KEY_LENGTH, NEXO_IV_LENGTH} from "../typings/constants/nexoConstants";
|
||||
import { NexoDerivedKey } from "../typings/terminal";
|
||||
import {NexoEnum} from "../constants/nexoConstants";
|
||||
|
||||
class NexoDerivedKeyGenerator {
|
||||
public static deriveKeyMaterial(passphrase: string): NexoDerivedKey {
|
||||
const pass = Buffer.from(passphrase, "binary");
|
||||
const salt = Buffer.from("AdyenNexoV1Salt", "binary");
|
||||
const iterations = 4000;
|
||||
const keylen = NEXO_CIPHER_KEY_LENGTH + NEXO_HMAC_KEY_LENGTH + NEXO_IV_LENGTH;
|
||||
const keylen = NexoEnum.CIPHER_KEY_LENGTH + NexoEnum.HMAC_KEY_LENGTH + NexoEnum.IV_LENGTH;
|
||||
const key = pbkdf2Sync(pass, salt, iterations, keylen * 8, "sha1");
|
||||
return NexoDerivedKeyGenerator.readKeyData(key);
|
||||
}
|
||||
|
||||
private static readKeyData(key: Buffer): NexoDerivedKey {
|
||||
return {
|
||||
cipherKey: key.slice(NEXO_HMAC_KEY_LENGTH, NEXO_HMAC_KEY_LENGTH + NEXO_CIPHER_KEY_LENGTH),
|
||||
hmacKey: key.slice(0, NEXO_HMAC_KEY_LENGTH),
|
||||
cipherKey: key.slice(NexoEnum.HMAC_KEY_LENGTH, NexoEnum.HMAC_KEY_LENGTH + NexoEnum.CIPHER_KEY_LENGTH),
|
||||
hmacKey: key.slice(0, NexoEnum.HMAC_KEY_LENGTH),
|
||||
iv: key.slice(
|
||||
NEXO_HMAC_KEY_LENGTH + NEXO_CIPHER_KEY_LENGTH,
|
||||
NEXO_CIPHER_KEY_LENGTH + NEXO_HMAC_KEY_LENGTH + NEXO_IV_LENGTH,
|
||||
NexoEnum.HMAC_KEY_LENGTH + NexoEnum.CIPHER_KEY_LENGTH,
|
||||
NexoEnum.CIPHER_KEY_LENGTH + NexoEnum.HMAC_KEY_LENGTH + NexoEnum.IV_LENGTH,
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -22,12 +22,6 @@ import ApiKeyAuthenticatedService from "../apiKeyAuthenticatedService";
|
||||
import Client from "../client";
|
||||
import GetCostEstimate from "./resource/binLookup/getCostEstimate";
|
||||
import Get3dsAvailability from "./resource/binLookup/get3dsAvailability";
|
||||
import {
|
||||
CostEstimateRequest,
|
||||
CostEstimateResponse,
|
||||
ThreeDSAvailabilityRequest,
|
||||
ThreeDSAvailabilityResponse
|
||||
} from "../typings/binLookup";
|
||||
import getJsonResponse from "../helpers/getJsonResponse";
|
||||
|
||||
class BinLookup extends ApiKeyAuthenticatedService {
|
||||
@@ -40,15 +34,15 @@ class BinLookup extends ApiKeyAuthenticatedService {
|
||||
this._getCostEstimate = new GetCostEstimate(this);
|
||||
}
|
||||
|
||||
public get3dsAvailability(request: ThreeDSAvailabilityRequest): Promise<ThreeDSAvailabilityResponse> {
|
||||
return getJsonResponse<ThreeDSAvailabilityRequest, ThreeDSAvailabilityResponse>(
|
||||
public get3dsAvailability(request: IBinLookup.ThreeDSAvailabilityRequest): Promise<IBinLookup.ThreeDSAvailabilityResponse> {
|
||||
return getJsonResponse<IBinLookup.ThreeDSAvailabilityRequest, IBinLookup.ThreeDSAvailabilityResponse>(
|
||||
this._get3dsAvailability,
|
||||
request
|
||||
);
|
||||
}
|
||||
|
||||
public getCostEstimate(request: CostEstimateRequest): Promise<CostEstimateResponse> {
|
||||
return getJsonResponse<CostEstimateRequest, CostEstimateResponse>(
|
||||
public getCostEstimate(request: IBinLookup.CostEstimateRequest): Promise<IBinLookup.CostEstimateResponse> {
|
||||
return getJsonResponse<IBinLookup.CostEstimateRequest, IBinLookup.CostEstimateResponse>(
|
||||
this._getCostEstimate,
|
||||
request
|
||||
);
|
||||
|
||||
@@ -22,16 +22,12 @@
|
||||
import ApiKeyAuthenticatedService from "../apiKeyAuthenticatedService";
|
||||
import Client from "../client";
|
||||
import getJsonResponse from "../helpers/getJsonResponse";
|
||||
import {
|
||||
DetailsRequest, PaymentMethodsRequest, PaymentMethodsResponse, PaymentRequest, PaymentResponse, PaymentSetupRequest,
|
||||
PaymentSetupResponse, PaymentVerificationRequest, PaymentVerificationResponse,
|
||||
} from "../typings/checkout";
|
||||
import { RequestOptions } from "../typings/requestOptions";
|
||||
import PaymentMethods from "./resource/checkout/paymentMethods";
|
||||
import Payments from "./resource/checkout/payments";
|
||||
import PaymentsDetails from "./resource/checkout/paymentsDetails";
|
||||
import PaymentSession from "./resource/checkout/paymentSession";
|
||||
import PaymentsResult from "./resource/checkout/paymentsResult";
|
||||
import PaymentLinks from "./resource/checkout/paymentLinks";
|
||||
import setApplicationInfo from "../helpers/setApplicationInfo";
|
||||
|
||||
class Checkout extends ApiKeyAuthenticatedService {
|
||||
@@ -40,6 +36,7 @@ class Checkout extends ApiKeyAuthenticatedService {
|
||||
private readonly _paymentsDetails: PaymentsDetails;
|
||||
private readonly _paymentSession: PaymentSession;
|
||||
private readonly _paymentsResult: PaymentsResult;
|
||||
private readonly _paymentLinks: PaymentLinks;
|
||||
|
||||
public constructor(client: Client) {
|
||||
super(client);
|
||||
@@ -48,43 +45,51 @@ class Checkout extends ApiKeyAuthenticatedService {
|
||||
this._paymentsDetails = new PaymentsDetails(this);
|
||||
this._paymentSession = new PaymentSession(this);
|
||||
this._paymentsResult = new PaymentsResult(this);
|
||||
this._paymentLinks = new PaymentLinks(this);
|
||||
}
|
||||
|
||||
public payments(paymentsRequest: PaymentRequest, requestOptions?: RequestOptions): Promise<PaymentResponse> {
|
||||
return getJsonResponse<PaymentRequest, PaymentResponse>(
|
||||
public payments(paymentsRequest: ICheckout.PaymentRequest, requestOptions?: IRequest.Options): Promise<ICheckout.PaymentResponse> {
|
||||
return getJsonResponse<ICheckout.PaymentRequest, ICheckout.PaymentResponse>(
|
||||
this._payments,
|
||||
setApplicationInfo(paymentsRequest),
|
||||
requestOptions,
|
||||
);
|
||||
}
|
||||
|
||||
public paymentMethods(paymentMethodsRequest: PaymentMethodsRequest): Promise<PaymentMethodsResponse> {
|
||||
return getJsonResponse<PaymentMethodsRequest, PaymentMethodsResponse>(
|
||||
public paymentMethods(paymentMethodsRequest: ICheckout.PaymentMethodsRequest): Promise<ICheckout.PaymentMethodsResponse> {
|
||||
return getJsonResponse<ICheckout.PaymentMethodsRequest, ICheckout.PaymentMethodsResponse>(
|
||||
this._paymentMethods,
|
||||
paymentMethodsRequest,
|
||||
);
|
||||
}
|
||||
|
||||
public paymentsDetails(paymentsDetailsRequest: DetailsRequest): Promise<PaymentResponse> {
|
||||
return getJsonResponse<DetailsRequest, PaymentResponse>(
|
||||
public paymentLinks(paymentLinkRequest: ICheckout.CreatePaymentLinkRequest): Promise<ICheckout.CreatePaymentLinkResponse> {
|
||||
return getJsonResponse<ICheckout.CreatePaymentLinkRequest, ICheckout.CreatePaymentLinkResponse>(
|
||||
this._paymentLinks,
|
||||
paymentLinkRequest
|
||||
);
|
||||
}
|
||||
|
||||
public paymentsDetails(paymentsDetailsRequest: ICheckout.DetailsRequest): Promise<ICheckout.PaymentResponse> {
|
||||
return getJsonResponse<ICheckout.DetailsRequest, ICheckout.PaymentResponse>(
|
||||
this._paymentsDetails,
|
||||
paymentsDetailsRequest,
|
||||
);
|
||||
}
|
||||
|
||||
public paymentSession(
|
||||
paymentSessionRequest: PaymentSetupRequest,
|
||||
requestOptions?: RequestOptions,
|
||||
): Promise<PaymentSetupResponse> {
|
||||
return getJsonResponse<PaymentSetupRequest, PaymentSetupResponse>(
|
||||
paymentSessionRequest: ICheckout.PaymentSetupRequest,
|
||||
requestOptions?: IRequest.Options,
|
||||
): Promise<ICheckout.PaymentSetupResponse> {
|
||||
return getJsonResponse<ICheckout.PaymentSetupRequest, ICheckout.PaymentSetupResponse>(
|
||||
this._paymentSession,
|
||||
paymentSessionRequest,
|
||||
requestOptions,
|
||||
);
|
||||
}
|
||||
|
||||
public paymentResult(paymentResultRequest: PaymentVerificationRequest): Promise<PaymentVerificationResponse> {
|
||||
return getJsonResponse<PaymentVerificationRequest, PaymentVerificationResponse>(
|
||||
public paymentResult(paymentResultRequest: ICheckout.PaymentVerificationRequest): Promise<ICheckout.PaymentVerificationResponse> {
|
||||
return getJsonResponse<ICheckout.PaymentVerificationRequest, ICheckout.PaymentVerificationResponse>(
|
||||
this._paymentsResult,
|
||||
paymentResultRequest,
|
||||
);
|
||||
|
||||
@@ -22,7 +22,6 @@
|
||||
import ApiKeyAuthenticatedService from "../apiKeyAuthenticatedService";
|
||||
import Client from "../client";
|
||||
import getJsonResponse from "../helpers/getJsonResponse";
|
||||
import { CheckoutUtilityRequest, CheckoutUtilityResponse } from "../typings/checkoutUtility";
|
||||
import OriginKeys from "./resource/checkoutUtility/originKeys";
|
||||
|
||||
class CheckoutUtility extends ApiKeyAuthenticatedService {
|
||||
@@ -33,8 +32,8 @@ class CheckoutUtility extends ApiKeyAuthenticatedService {
|
||||
this._originKeys = new OriginKeys(this);
|
||||
}
|
||||
|
||||
public originKeys(originKeysRequest: CheckoutUtilityRequest): Promise<CheckoutUtilityResponse> {
|
||||
return getJsonResponse<CheckoutUtilityRequest, CheckoutUtilityResponse>(
|
||||
public originKeys(originKeysRequest: ICheckoutUtility.CheckoutUtilityRequest): Promise<ICheckoutUtility.CheckoutUtilityResponse> {
|
||||
return getJsonResponse<ICheckoutUtility.CheckoutUtilityRequest, ICheckoutUtility.CheckoutUtilityResponse>(
|
||||
this._originKeys,
|
||||
originKeysRequest,
|
||||
);
|
||||
|
||||
@@ -21,8 +21,6 @@
|
||||
import Client from "../client";
|
||||
import getJsonResponse from "../helpers/getJsonResponse";
|
||||
import Service from "../service";
|
||||
import { ModificationRequest, ModificationResult } from "../typings/payments";
|
||||
import { RequestOptions } from "../typings/requestOptions";
|
||||
import AdjustAuthorisation from "./resource/modification/adjustAuthorisation";
|
||||
import Cancel from "./resource/modification/cancel";
|
||||
import CancelOrRefund from "./resource/modification/cancelOrRefund";
|
||||
@@ -30,6 +28,10 @@ import Capture from "./resource/modification/capture";
|
||||
import Refund from "./resource/modification/refund";
|
||||
import TechnicalCancel from "./resource/modification/technicalCancel";
|
||||
import setApplicationInfo from "../helpers/setApplicationInfo";
|
||||
import {ApplicationInfo} from "../typings/applicationInfo";
|
||||
|
||||
interface AppInfo { applicationInfo?: ApplicationInfo }
|
||||
type GenericRequest<T> = T & AppInfo;
|
||||
|
||||
class Modification extends Service {
|
||||
private readonly _cancelOrRefund: CancelOrRefund;
|
||||
@@ -50,10 +52,10 @@ class Modification extends Service {
|
||||
}
|
||||
|
||||
public capture(
|
||||
captureRequest: ModificationRequest,
|
||||
requestOptions?: RequestOptions,
|
||||
): Promise<ModificationResult> {
|
||||
return getJsonResponse<ModificationRequest, ModificationResult>(
|
||||
captureRequest: GenericRequest<IPayments.ModificationRequest>,
|
||||
requestOptions?: IRequest.Options,
|
||||
): Promise<IPayments.ModificationResult> {
|
||||
return getJsonResponse<IPayments.ModificationRequest, IPayments.ModificationResult>(
|
||||
this._capture,
|
||||
setApplicationInfo(captureRequest),
|
||||
requestOptions,
|
||||
@@ -61,10 +63,10 @@ class Modification extends Service {
|
||||
}
|
||||
|
||||
public cancelOrRefund(
|
||||
cancelOrRefundRequest: ModificationRequest,
|
||||
requestOptions?: RequestOptions,
|
||||
): Promise<ModificationResult> {
|
||||
return getJsonResponse<ModificationRequest, ModificationResult>(
|
||||
cancelOrRefundRequest: GenericRequest<IPayments.ModificationRequest>,
|
||||
requestOptions?: IRequest.Options,
|
||||
): Promise<IPayments.ModificationResult> {
|
||||
return getJsonResponse<IPayments.ModificationRequest, IPayments.ModificationResult>(
|
||||
this._cancelOrRefund,
|
||||
setApplicationInfo(cancelOrRefundRequest),
|
||||
requestOptions,
|
||||
@@ -72,10 +74,10 @@ class Modification extends Service {
|
||||
}
|
||||
|
||||
public refund(
|
||||
refundRequest: ModificationRequest,
|
||||
requestOptions?: RequestOptions,
|
||||
): Promise<ModificationResult> {
|
||||
return getJsonResponse<ModificationRequest, ModificationResult>(
|
||||
refundRequest: GenericRequest<IPayments.ModificationRequest>,
|
||||
requestOptions?: IRequest.Options,
|
||||
): Promise<IPayments.ModificationResult> {
|
||||
return getJsonResponse<IPayments.ModificationRequest, IPayments.ModificationResult>(
|
||||
this._refund,
|
||||
setApplicationInfo(refundRequest),
|
||||
requestOptions,
|
||||
@@ -83,10 +85,10 @@ class Modification extends Service {
|
||||
}
|
||||
|
||||
public cancel(
|
||||
cancelRequest: ModificationRequest,
|
||||
requestOptions?: RequestOptions,
|
||||
): Promise<ModificationResult> {
|
||||
return getJsonResponse<ModificationRequest, ModificationResult>(
|
||||
cancelRequest: GenericRequest<IPayments.ModificationRequest>,
|
||||
requestOptions?: IRequest.Options,
|
||||
): Promise<IPayments.ModificationResult> {
|
||||
return getJsonResponse<IPayments.ModificationRequest, IPayments.ModificationResult>(
|
||||
this._cancel,
|
||||
setApplicationInfo(cancelRequest),
|
||||
requestOptions,
|
||||
@@ -94,10 +96,10 @@ class Modification extends Service {
|
||||
}
|
||||
|
||||
public technicalCancel(
|
||||
technicalCancelRequest: ModificationRequest,
|
||||
requestOptions?: RequestOptions,
|
||||
): Promise<ModificationResult> {
|
||||
return getJsonResponse<ModificationRequest, ModificationResult>(
|
||||
technicalCancelRequest: GenericRequest<IPayments.ModificationRequest>,
|
||||
requestOptions?: IRequest.Options,
|
||||
): Promise<IPayments.ModificationResult> {
|
||||
return getJsonResponse<IPayments.ModificationRequest, IPayments.ModificationResult>(
|
||||
this._technicalCancel,
|
||||
setApplicationInfo(technicalCancelRequest),
|
||||
requestOptions,
|
||||
@@ -105,10 +107,10 @@ class Modification extends Service {
|
||||
}
|
||||
|
||||
public adjustAuthorisation(
|
||||
adjustAuthorisationRequest: ModificationRequest,
|
||||
requestOptions?: RequestOptions,
|
||||
): Promise<ModificationResult> {
|
||||
return getJsonResponse<ModificationRequest, ModificationResult>(
|
||||
adjustAuthorisationRequest: GenericRequest<IPayments.ModificationRequest>,
|
||||
requestOptions?: IRequest.Options,
|
||||
): Promise<IPayments.ModificationResult> {
|
||||
return getJsonResponse<IPayments.ModificationRequest, IPayments.ModificationResult>(
|
||||
this._adjustAuthorisation,
|
||||
setApplicationInfo(adjustAuthorisationRequest),
|
||||
requestOptions,
|
||||
|
||||
@@ -26,12 +26,6 @@ import SubmitThirdParty from "./resource/payout/submitThirdParty";
|
||||
import ConfirmThirdParty from "./resource/payout/confirmThirdParty";
|
||||
import PayoutResource from "./resource/payout/payout";
|
||||
import StoreDetailAndSubmitThirdParty from "./resource/payout/storeDetailAndSubmitThirdParty";
|
||||
import {
|
||||
ModifyRequest,
|
||||
ModifyResponse,
|
||||
StoreDetailAndSubmitRequest,
|
||||
StoreDetailAndSubmitResponse, StoreDetailRequest, StoreDetailResponse, SubmitRequest, SubmitResponse, PayoutRequest, PayoutResponse
|
||||
} from "../typings/payout";
|
||||
import getJsonResponse from "../helpers/getJsonResponse";
|
||||
|
||||
class Payout extends Service {
|
||||
@@ -53,43 +47,43 @@ class Payout extends Service {
|
||||
this._payout = new PayoutResource(this);
|
||||
}
|
||||
|
||||
public storeDetailAndSubmitThirdParty(request: StoreDetailAndSubmitRequest): Promise<StoreDetailAndSubmitResponse> {
|
||||
return getJsonResponse<StoreDetailAndSubmitRequest, StoreDetailAndSubmitResponse>(
|
||||
public storeDetailAndSubmitThirdParty(request: IPayouts.StoreDetailAndSubmitRequest): Promise<IPayouts.StoreDetailAndSubmitResponse> {
|
||||
return getJsonResponse<IPayouts.StoreDetailAndSubmitRequest, IPayouts.StoreDetailAndSubmitResponse>(
|
||||
this._storeDetailAndSubmitThirdParty,
|
||||
request
|
||||
);
|
||||
}
|
||||
|
||||
public confirmThirdParty(request: ModifyRequest): Promise<ModifyResponse> {
|
||||
return getJsonResponse<ModifyRequest, ModifyResponse>(
|
||||
public confirmThirdParty(request: IPayouts.ModifyRequest): Promise<IPayouts.ModifyResponse> {
|
||||
return getJsonResponse<IPayouts.ModifyRequest, IPayouts.ModifyResponse>(
|
||||
this._confirmThirdParty,
|
||||
request
|
||||
);
|
||||
}
|
||||
|
||||
public declineThirdParty(request: ModifyRequest): Promise<ModifyResponse> {
|
||||
return getJsonResponse<ModifyRequest, ModifyResponse>(
|
||||
public declineThirdParty(request: IPayouts.ModifyRequest): Promise<IPayouts.ModifyResponse> {
|
||||
return getJsonResponse<IPayouts.ModifyRequest, IPayouts.ModifyResponse>(
|
||||
this._declineThirdParty,
|
||||
request
|
||||
);
|
||||
}
|
||||
|
||||
public storeDetail(request: StoreDetailRequest): Promise<StoreDetailResponse> {
|
||||
return getJsonResponse<StoreDetailRequest, StoreDetailResponse>(
|
||||
public storeDetail(request: IPayouts.StoreDetailRequest): Promise<IPayouts.StoreDetailResponse> {
|
||||
return getJsonResponse<IPayouts.StoreDetailRequest, IPayouts.StoreDetailResponse>(
|
||||
this._storeDetail,
|
||||
request
|
||||
);
|
||||
}
|
||||
|
||||
public submitThirdparty(request: SubmitRequest): Promise<SubmitResponse> {
|
||||
return getJsonResponse<SubmitRequest, SubmitResponse>(
|
||||
public submitThirdparty(request: IPayouts.SubmitRequest): Promise<IPayouts.SubmitResponse> {
|
||||
return getJsonResponse<IPayouts.SubmitRequest, IPayouts.SubmitResponse>(
|
||||
this._submitThirdParty,
|
||||
request
|
||||
);
|
||||
}
|
||||
|
||||
public payout(request: PayoutRequest): Promise<PayoutResponse> {
|
||||
return getJsonResponse<PayoutRequest, PayoutResponse>(
|
||||
public payout(request: IPayouts.PayoutRequest): Promise<IPayouts.PayoutResponse> {
|
||||
return getJsonResponse<IPayouts.PayoutRequest, IPayouts.PayoutResponse>(
|
||||
this._payout,
|
||||
request
|
||||
);
|
||||
|
||||
@@ -22,7 +22,6 @@
|
||||
import Client from "../client";
|
||||
import getJsonResponse from "../helpers/getJsonResponse";
|
||||
import Service from "../service";
|
||||
import { DisableRequest, DisableResult, RecurringDetailsRequest, RecurringDetailsResult } from "../typings/recurring";
|
||||
import Disable from "./resource/recurring/disable";
|
||||
import ListRecurringDetails from "./resource/recurring/listRecurringDetails";
|
||||
|
||||
@@ -36,15 +35,15 @@ class Recurring extends Service {
|
||||
this._disable = new Disable(this);
|
||||
}
|
||||
|
||||
public listRecurringDetails(request: RecurringDetailsRequest): Promise<RecurringDetailsResult> {
|
||||
return getJsonResponse<RecurringDetailsRequest, RecurringDetailsResult>(
|
||||
public listRecurringDetails(request: IRecurring.RecurringDetailsRequest): Promise<IRecurring.RecurringDetailsResult> {
|
||||
return getJsonResponse<IRecurring.RecurringDetailsRequest, IRecurring.RecurringDetailsResult>(
|
||||
this._listRecurringDetails,
|
||||
request,
|
||||
);
|
||||
}
|
||||
|
||||
public disable(request: DisableRequest): Promise<DisableResult> {
|
||||
return getJsonResponse<DisableRequest, DisableResult>(
|
||||
public disable(request: IRecurring.DisableRequest): Promise<IRecurring.DisableResult> {
|
||||
return getJsonResponse<IRecurring.DisableRequest, IRecurring.DisableResult>(
|
||||
this._disable,
|
||||
request,
|
||||
);
|
||||
|
||||
@@ -20,11 +20,10 @@
|
||||
*/
|
||||
|
||||
import Config from "../config";
|
||||
import ClientInterface from "../typings/httpClient/clientInterface";
|
||||
import Service from "../service";
|
||||
import { RequestOptions } from "../typings/requestOptions";
|
||||
import HttpClientException from "../httpClient/httpClientException";
|
||||
import ApiException from "./exception/apiException";
|
||||
import ClientInterface from "../httpClient/clientInterface";
|
||||
|
||||
abstract class Resource {
|
||||
protected endpoint: string;
|
||||
@@ -35,7 +34,7 @@ abstract class Resource {
|
||||
this.endpoint = endpoint;
|
||||
}
|
||||
|
||||
public request(json: string, requestOptions?: RequestOptions): Promise<string | HttpClientException | ApiException> {
|
||||
public request(json: string, requestOptions?: IRequest.Options): Promise<string | HttpClientException | ApiException> {
|
||||
const clientInterface: ClientInterface = this.service.client.httpClient;
|
||||
const config: Config = this.service.client.config;
|
||||
|
||||
|
||||
35
src/services/resource/checkout/paymentLinks.ts
Normal file
35
src/services/resource/checkout/paymentLinks.ts
Normal file
@@ -0,0 +1,35 @@
|
||||
/*
|
||||
* ######
|
||||
* ######
|
||||
* ############ ####( ###### #####. ###### ############ ############
|
||||
* ############# #####( ###### #####. ###### ############# #############
|
||||
* ###### #####( ###### #####. ###### ##### ###### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ######
|
||||
* ############# ############# ############# ############# ##### ######
|
||||
* ############ ############ ############# ############ ##### ######
|
||||
* ######
|
||||
* #############
|
||||
* ############
|
||||
*
|
||||
* Adyen NodeJS API Library
|
||||
*
|
||||
* Copyright (c) 2019 Adyen B.V.
|
||||
* This file is open source and available under the MIT license.
|
||||
* See the LICENSE file for more info.
|
||||
*/
|
||||
|
||||
import Client from "../../../client";
|
||||
import Service from "../../../service";
|
||||
import Resource from "../../resource";
|
||||
|
||||
class PaymentLinks extends Resource {
|
||||
public constructor(service: Service) {
|
||||
super(
|
||||
service,
|
||||
`${service.client.config.checkoutEndpoint}/${Client.CHECKOUT_API_VERSION}/paymentLinks`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
export default PaymentLinks;
|
||||
@@ -25,6 +25,8 @@ import getJsonResponse from "../helpers/getJsonResponse";
|
||||
import {Convert, TerminalApiRequest, TerminalApiResponse} from "../typings/terminal";
|
||||
import Async from "./resource/terminal/cloud/async";
|
||||
import Sync from "./resource/terminal/cloud/sync";
|
||||
import mergeDeep from "../utils/mergeDeep";
|
||||
import {ApplicationInfo} from "../typings/applicationInfo";
|
||||
|
||||
class TerminalCloudAPI extends ApiKeyAuthenticatedService {
|
||||
private readonly terminalApiAsync: Async;
|
||||
@@ -36,17 +38,28 @@ class TerminalCloudAPI extends ApiKeyAuthenticatedService {
|
||||
this.terminalApiSync = new Sync(this);
|
||||
}
|
||||
|
||||
private static setApplicationInfo(request: TerminalApiRequest): TerminalApiRequest {
|
||||
const applicationInfo = new ApplicationInfo();
|
||||
|
||||
const saleToAcquirerData = {applicationInfo};
|
||||
const saleData = {saleToAcquirerData};
|
||||
const paymentRequest = {saleData};
|
||||
const saleToPoiRequest = {paymentRequest};
|
||||
const newRequest = {saleToPoiRequest};
|
||||
|
||||
return mergeDeep(request, newRequest);
|
||||
}
|
||||
|
||||
public async(terminalApiRequest: TerminalApiRequest): Promise<string> {
|
||||
return getJsonResponse<TerminalApiRequest>(
|
||||
this.terminalApiAsync,
|
||||
Convert.terminalApiRequestToJson(terminalApiRequest),
|
||||
);
|
||||
const request = TerminalCloudAPI.setApplicationInfo(terminalApiRequest);
|
||||
return getJsonResponse<TerminalApiRequest>(this.terminalApiAsync, Convert.terminalApiRequestToJson(request));
|
||||
}
|
||||
|
||||
public async sync(terminalApiRequest: TerminalApiRequest): Promise<TerminalApiResponse> {
|
||||
const request = TerminalCloudAPI.setApplicationInfo(terminalApiRequest);
|
||||
const response = await getJsonResponse<TerminalApiRequest, TerminalApiResponse>(
|
||||
this.terminalApiSync,
|
||||
Convert.terminalApiRequestToJson(terminalApiRequest),
|
||||
Convert.terminalApiRequestToJson(request),
|
||||
);
|
||||
|
||||
return Convert.toTerminalApiResponse(JSON.stringify(response));
|
||||
|
||||
@@ -1,3 +1,25 @@
|
||||
/*
|
||||
* ######
|
||||
* ######
|
||||
* ############ ####( ###### #####. ###### ############ ############
|
||||
* ############# #####( ###### #####. ###### ############# #############
|
||||
* ###### #####( ###### #####. ###### ##### ###### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ######
|
||||
* ############# ############# ############# ############# ##### ######
|
||||
* ############ ############ ############# ############ ##### ######
|
||||
* ######
|
||||
* #############
|
||||
* ############
|
||||
*
|
||||
* Adyen NodeJS API Library
|
||||
*
|
||||
*
|
||||
* Copyright (c) 2019 Adyen B.V.
|
||||
* This file is open source and available under the MIT license.
|
||||
* See the LICENSE file for more info.
|
||||
*/
|
||||
|
||||
export interface Amount {
|
||||
currency: string;
|
||||
value: number;
|
||||
|
||||
@@ -1,3 +1,24 @@
|
||||
/*
|
||||
* ######
|
||||
* ######
|
||||
* ############ ####( ###### #####. ###### ############ ############
|
||||
* ############# #####( ###### #####. ###### ############# #############
|
||||
* ###### #####( ###### #####. ###### ##### ###### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ######
|
||||
* ############# ############# ############# ############# ##### ######
|
||||
* ############ ############ ############# ############ ##### ######
|
||||
* ######
|
||||
* #############
|
||||
* ############
|
||||
*
|
||||
* Adyen NodeJS API Library
|
||||
*
|
||||
* Copyright (c) 2019 Adyen B.V.
|
||||
* This file is open source and available under the MIT license.
|
||||
* See the LICENSE file for more info.
|
||||
*/
|
||||
|
||||
// Generated using typescript-generator version 2.14.505 on 2019-06-04 08:51:10.
|
||||
|
||||
export interface ApiError {
|
||||
|
||||
@@ -1,3 +1,24 @@
|
||||
/*
|
||||
* ######
|
||||
* ######
|
||||
* ############ ####( ###### #####. ###### ############ ############
|
||||
* ############# #####( ###### #####. ###### ############# #############
|
||||
* ###### #####( ###### #####. ###### ##### ###### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ######
|
||||
* ############# ############# ############# ############# ##### ######
|
||||
* ############ ############ ############# ############ ##### ######
|
||||
* ######
|
||||
* #############
|
||||
* ############
|
||||
*
|
||||
* Adyen NodeJS API Library
|
||||
*
|
||||
* Copyright (c) 2019 Adyen B.V.
|
||||
* This file is open source and available under the MIT license.
|
||||
* See the LICENSE file for more info.
|
||||
*/
|
||||
|
||||
// Generated using typescript-generator version 2.14.505 on 2019-06-11 10:28:22.
|
||||
|
||||
import Client from "../client";
|
||||
|
||||
341
src/typings/binLookup.ts
Normal file
341
src/typings/binLookup.ts
Normal file
@@ -0,0 +1,341 @@
|
||||
|
||||
/*
|
||||
* ######
|
||||
* ######
|
||||
* ############ ####( ###### #####. ###### ############ ############
|
||||
* ############# #####( ###### #####. ###### ############# #############
|
||||
* ###### #####( ###### #####. ###### ##### ###### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ##### ######
|
||||
* ###### ###### #####( ###### #####. ###### ##### ##### ######
|
||||
* ############# ############# ############# ############# ##### ######
|
||||
* ############ ############ ############# ############ ##### ######
|
||||
* ######
|
||||
* #############
|
||||
* ############
|
||||
*
|
||||
* Adyen NodeJS API Library
|
||||
*
|
||||
* Version of BinLookup: v50
|
||||
*
|
||||
* Copyright (c) 2019 Adyen B.V.
|
||||
* This file is open source and available under the MIT license.
|
||||
* See the LICENSE file for more info.
|
||||
*/
|
||||
|
||||
|
||||
declare namespace IBinLookup {
|
||||
export interface Amount {
|
||||
/**
|
||||
* The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
|
||||
*/
|
||||
currency: string;
|
||||
/**
|
||||
* 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).
|
||||
*/
|
||||
value: number; // int64
|
||||
}
|
||||
export interface BinDetail {
|
||||
/**
|
||||
* The country where the card was issued.
|
||||
*/
|
||||
issuerCountry?: string;
|
||||
}
|
||||
export interface CardBin {
|
||||
/**
|
||||
* The first 6 digit of the card number. Enable this field via merchant account settings.
|
||||
*/
|
||||
bin?: string;
|
||||
/**
|
||||
* If true, it indicates a commercial card. Enable this field via merchant account settings.
|
||||
*/
|
||||
commercial?: boolean;
|
||||
/**
|
||||
* The card funding source. Valid values are:
|
||||
* * CHARGE
|
||||
* * CREDIT
|
||||
* * DEBIT
|
||||
* * DEFERRED_DEBIT
|
||||
* * PREPAID
|
||||
* * PREPAID_RELOADABLE
|
||||
* * PREPAID_NONRELOADABLE
|
||||
* > Enable this field via merchant account settings.
|
||||
*/
|
||||
fundingSource?: string;
|
||||
/**
|
||||
* 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 different from "N" or "U".
|
||||
*/
|
||||
fundsAvailability?: string;
|
||||
/**
|
||||
* The issuing bank of the card.
|
||||
*/
|
||||
issuingBank?: string;
|
||||
/**
|
||||
* The country where the card was issued from.
|
||||
*/
|
||||
issuingCountry?: string;
|
||||
/**
|
||||
* The currency of the card.
|
||||
*/
|
||||
issuingCurrency?: string;
|
||||
/**
|
||||
* The payment method associated with the card (e.g. visa, mc, or amex).
|
||||
*/
|
||||
paymentMethod?: string;
|
||||
/**
|
||||
* 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)
|
||||
* > Returned when you verify a card BIN or estimate costs, and only if `payoutEligible` is different from "N" or "U".
|
||||
*/
|
||||
payoutEligible?: string;
|
||||
/**
|
||||
* The last four digits of the card number.
|
||||
*/
|
||||
summary?: string;
|
||||
}
|
||||
export interface CostEstimateAssumptions {
|
||||
/**
|
||||
* If true, the cardholder is expected to successfully authorise via 3D Secure.
|
||||
*/
|
||||
assume3DSecureAuthenticated?: boolean;
|
||||
/**
|
||||
* If true, the transaction is expected to have valid Level 3 data.
|
||||
*/
|
||||
assumeLevel3Data?: boolean;
|
||||
/**
|
||||
* If not zero, the number of installments.
|
||||
*/
|
||||
installments?: number; // int32
|
||||
}
|
||||
export interface CostEstimateRequest {
|
||||
/**
|
||||
* The transaction amount used as a base for the cost estimation.
|
||||
*/
|
||||
amount: IBinLookup.Amount;
|
||||
/**
|
||||
* Assumptions made for the expected characteristics of the transaction, for which the charges are being estimated.
|
||||
*/
|
||||
assumptions?: IBinLookup.CostEstimateAssumptions;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
cardNumber?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The merchant account identifier you want to process the (transaction) request with.
|
||||
*/
|
||||
merchantAccount: string;
|
||||
/**
|
||||
* Additional data for merchants who don't use Adyen as the payment authorisation gateway.
|
||||
*/
|
||||
merchantDetails?: IBinLookup.MerchantDetails;
|
||||
/**
|
||||
* The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/checkout/tokenization).
|
||||
*/
|
||||
recurring?: IBinLookup.Recurring;
|
||||
/**
|
||||
* The `recurringDetailReference` you want to use for this cost estimate. The value `LATEST` can be used to select the most recently stored recurring detail.
|
||||
*/
|
||||
selectedRecurringDetailReference?: string;
|
||||
/**
|
||||
* 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?: "Ecommerce" | "ContAuth" | "Moto" | "POS";
|
||||
/**
|
||||
* The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).
|
||||
* > This field is required for recurring payments.
|
||||
*/
|
||||
shopperReference?: string;
|
||||
}
|
||||
export interface CostEstimateResponse {
|
||||
/**
|
||||
* Card BIN details.
|
||||
*/
|
||||
cardBin?: IBinLookup.CardBin;
|
||||
/**
|
||||
* The estimated cost (scheme fee + interchange) in the settlement currency. If the settlement currency cannot be determined, the fee in EUR is returned.
|
||||
*/
|
||||
costEstimateAmount?: IBinLookup.Amount;
|
||||
/**
|
||||
* The result of the cost estimation.
|
||||
*/
|
||||
resultCode?: string;
|
||||
/**
|
||||
* Indicates the way the charges can be passed on to the cardholder. The following values are possible:
|
||||
* * `ZERO` - the charges are not allowed to pass on
|
||||
* * `PASSTHROUGH` - the charges can be passed on
|
||||
* * `UNLIMITED` - there is no limit on how much surcharge is passed on
|
||||
*/
|
||||
surchargeType?: string;
|
||||
}
|
||||
export interface DSPublicKeyDetail {
|
||||
/**
|
||||
* Card brand.
|
||||
*/
|
||||
brand?: string;
|
||||
/**
|
||||
* Directory Server (DS) identifier.
|
||||
*/
|
||||
directoryServerId?: string;
|
||||
/**
|
||||
* Public key. The 3D Secure 2 SDK encrypts the device information by using the DS public key.
|
||||
*/
|
||||
publicKey?: string; // byte
|
||||
}
|
||||
export interface MerchantDetails {
|
||||
/**
|
||||
* 2-letter ISO 3166 country code of the card acceptor location.
|
||||
* > This parameter is required for the merchants who don't use Adyen as the payment authorisation gateway.
|
||||
*/
|
||||
countryCode?: string;
|
||||
/**
|
||||
* If true, indicates that the merchant is enrolled in 3D Secure for the card network.
|
||||
*/
|
||||
enrolledIn3DSecure?: boolean;
|
||||
/**
|
||||
* The 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.
|
||||
*
|
||||
* The list of MCCs can be found [here](https://en.wikipedia.org/wiki/Merchant_category_code).
|
||||
*/
|
||||
mcc?: string;
|
||||
}
|
||||
namespace Post {
|
||||
export type RequestBody = IBinLookup.CostEstimateRequest;
|
||||
namespace Responses {
|
||||
export type $200 = IBinLookup.CostEstimateResponse;
|
||||
}
|
||||
}
|
||||
export interface Recurring {
|
||||
/**
|
||||
* 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).
|
||||
*/
|
||||
contract?: "ONECLICK" | "RECURRING" | "PAYOUT";
|
||||
/**
|
||||
* A descriptive name for this detail.
|
||||
*/
|
||||
recurringDetailName?: string;
|
||||
/**
|
||||
* Date after which no further authorisations shall be performed. Only for 3D Secure 2.
|
||||
*/
|
||||
recurringExpiry?: string; // date-time
|
||||
/**
|
||||
* Minimum number of days between authorisations. Only for 3D Secure 2.
|
||||
*/
|
||||
recurringFrequency?: string;
|
||||
/**
|
||||
* The name of the token service.
|
||||
*/
|
||||
tokenService?: "VISATOKENSERVICE" | "MCTOKENSERVICE";
|
||||
}
|
||||
export interface ThreeDS2CardRangeDetail {
|
||||
/**
|
||||
* Card brand.
|
||||
*/
|
||||
brandCode?: string;
|
||||
/**
|
||||
* BIN end range.
|
||||
*/
|
||||
endRange?: string;
|
||||
/**
|
||||
* BIN start range.
|
||||
*/
|
||||
startRange?: string;
|
||||
/**
|
||||
* 3D Secure protocol version.
|
||||
*/
|
||||
threeDS2Version?: string;
|
||||
/**
|
||||
* In a 3D Secure 2 browser-based flow, this is the URL where you should send the device fingerprint to.
|
||||
*/
|
||||
threeDSMethodURL?: string;
|
||||
}
|
||||
export interface ThreeDSAvailabilityRequest {
|
||||
/**
|
||||
* 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. For more information on possible key-value pairs, refer to the [additionalData section](https://docs.adyen.com/api-reference/payments-api/paymentrequest/paymentrequest-additionaldata).
|
||||
*/
|
||||
additionalData?: {
|
||||
};
|
||||
/**
|
||||
* List of brands.
|
||||
*/
|
||||
brands: string[];
|
||||
/**
|
||||
* Card number or BIN.
|
||||
*/
|
||||
cardNumber?: string;
|
||||
/**
|
||||
* The merchant account identifier.
|
||||
*/
|
||||
merchantAccount: string;
|
||||
/**
|
||||
* A recurring detail reference corresponding to a card.
|
||||
*/
|
||||
recurringDetailReference?: string;
|
||||
/**
|
||||
* The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).
|
||||
*/
|
||||
shopperReference?: string;
|
||||
}
|
||||
export interface ThreeDSAvailabilityResponse {
|
||||
/**
|
||||
* Bin Group Details
|
||||
*/
|
||||
binDetails?: IBinLookup.BinDetail;
|
||||
/**
|
||||
* List of Directory Server (DS) public keys.
|
||||
*/
|
||||
dsPublicKeys?: IBinLookup.DSPublicKeyDetail[];
|
||||
/**
|
||||
* Indicator if 3D Secure 1 is supported.
|
||||
*/
|
||||
threeDS1Supported?: boolean;
|
||||
/**
|
||||
* List of brand and card range pairs.
|
||||
*/
|
||||
threeDS2CardRangeDetails?: IBinLookup.ThreeDS2CardRangeDetail[];
|
||||
/**
|
||||
* Indicator if 3D Secure 2 is supported.
|
||||
*/
|
||||
threeDS2supported?: boolean;
|
||||
}
|
||||
}
|
||||
@@ -1,42 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Amount {
|
||||
/**
|
||||
* The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
|
||||
*/
|
||||
'currency': string;
|
||||
/**
|
||||
* 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).
|
||||
*/
|
||||
'value': number;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "currency",
|
||||
"baseName": "currency",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"baseName": "value",
|
||||
"type": "number"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Amount.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class BinDetail {
|
||||
/**
|
||||
* The country where the card was issued.
|
||||
*/
|
||||
'issuerCountry'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "issuerCountry",
|
||||
"baseName": "issuerCountry",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return BinDetail.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,114 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class CardBin {
|
||||
/**
|
||||
* The first 6 digit of the card number. Enable this field via merchant account settings.
|
||||
*/
|
||||
'bin'?: string;
|
||||
/**
|
||||
* If true, it indicates a commercial card. Enable this field via merchant account settings.
|
||||
*/
|
||||
'commercial'?: boolean;
|
||||
/**
|
||||
* The card funding source. Valid values are: * CHARGE * CREDIT * DEBIT * DEFERRED_DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE > Enable this field via merchant account settings.
|
||||
*/
|
||||
'fundingSource'?: string;
|
||||
/**
|
||||
* 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 different from \"N\" or \"U\".
|
||||
*/
|
||||
'fundsAvailability'?: string;
|
||||
/**
|
||||
* The issuing bank of the card.
|
||||
*/
|
||||
'issuingBank'?: string;
|
||||
/**
|
||||
* The country where the card was issued from.
|
||||
*/
|
||||
'issuingCountry'?: string;
|
||||
/**
|
||||
* The currency of the card.
|
||||
*/
|
||||
'issuingCurrency'?: string;
|
||||
/**
|
||||
* The payment method associated with the card (e.g. visa, mc, or amex).
|
||||
*/
|
||||
'paymentMethod'?: string;
|
||||
/**
|
||||
* 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) > Returned when you verify a card BIN or estimate costs, and only if `payoutEligible` is different from \"N\" or \"U\".
|
||||
*/
|
||||
'payoutEligible'?: string;
|
||||
/**
|
||||
* The last four digits of the card number.
|
||||
*/
|
||||
'summary'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "bin",
|
||||
"baseName": "bin",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "commercial",
|
||||
"baseName": "commercial",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "fundingSource",
|
||||
"baseName": "fundingSource",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "fundsAvailability",
|
||||
"baseName": "fundsAvailability",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "issuingBank",
|
||||
"baseName": "issuingBank",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "issuingCountry",
|
||||
"baseName": "issuingCountry",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "issuingCurrency",
|
||||
"baseName": "issuingCurrency",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "paymentMethod",
|
||||
"baseName": "paymentMethod",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "payoutEligible",
|
||||
"baseName": "payoutEligible",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "summary",
|
||||
"baseName": "summary",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return CardBin.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class CostEstimateAssumptions {
|
||||
/**
|
||||
* If true, the cardholder is expected to successfully authorise via 3D Secure.
|
||||
*/
|
||||
'assume3DSecureAuthenticated'?: boolean;
|
||||
/**
|
||||
* If true, the transaction is expected to have valid Level 3 data.
|
||||
*/
|
||||
'assumeLevel3Data'?: boolean;
|
||||
/**
|
||||
* If not zero, the number of installments.
|
||||
*/
|
||||
'installments'?: number;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "assume3DSecureAuthenticated",
|
||||
"baseName": "assume3DSecureAuthenticated",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "assumeLevel3Data",
|
||||
"baseName": "assumeLevel3Data",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "installments",
|
||||
"baseName": "installments",
|
||||
"type": "number"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return CostEstimateAssumptions.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,114 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Amount } from './amount';
|
||||
import { CostEstimateAssumptions } from './costEstimateAssumptions';
|
||||
import { MerchantDetails } from './merchantDetails';
|
||||
import { Recurring } from './recurring';
|
||||
|
||||
export class CostEstimateRequest {
|
||||
'amount': Amount;
|
||||
'assumptions'?: CostEstimateAssumptions;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'cardNumber'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The merchant account identifier you want to process the (transaction) request with.
|
||||
*/
|
||||
'merchantAccount': string;
|
||||
'merchantDetails'?: MerchantDetails;
|
||||
'recurring'?: Recurring;
|
||||
/**
|
||||
* The `recurringDetailReference` you want to use for this cost estimate. The value `LATEST` can be used to select the most recently stored recurring detail.
|
||||
*/
|
||||
'selectedRecurringDetailReference'?: string;
|
||||
/**
|
||||
* 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'?: CostEstimateRequest.ShopperInteractionEnum;
|
||||
/**
|
||||
* The shopper\'s reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments.
|
||||
*/
|
||||
'shopperReference'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "amount",
|
||||
"baseName": "amount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "assumptions",
|
||||
"baseName": "assumptions",
|
||||
"type": "CostEstimateAssumptions"
|
||||
},
|
||||
{
|
||||
"name": "cardNumber",
|
||||
"baseName": "cardNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "encryptedCard",
|
||||
"baseName": "encryptedCard",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantAccount",
|
||||
"baseName": "merchantAccount",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantDetails",
|
||||
"baseName": "merchantDetails",
|
||||
"type": "MerchantDetails"
|
||||
},
|
||||
{
|
||||
"name": "recurring",
|
||||
"baseName": "recurring",
|
||||
"type": "Recurring"
|
||||
},
|
||||
{
|
||||
"name": "selectedRecurringDetailReference",
|
||||
"baseName": "selectedRecurringDetailReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperInteraction",
|
||||
"baseName": "shopperInteraction",
|
||||
"type": "CostEstimateRequest.ShopperInteractionEnum"
|
||||
},
|
||||
{
|
||||
"name": "shopperReference",
|
||||
"baseName": "shopperReference",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return CostEstimateRequest.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace CostEstimateRequest {
|
||||
export enum ShopperInteractionEnum {
|
||||
Ecommerce = <any> 'Ecommerce',
|
||||
ContAuth = <any> 'ContAuth',
|
||||
Moto = <any> 'Moto',
|
||||
POS = <any> 'POS'
|
||||
}
|
||||
}
|
||||
@@ -1,56 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Amount } from './amount';
|
||||
import { CardBin } from './cardBin';
|
||||
|
||||
export class CostEstimateResponse {
|
||||
'cardBin'?: CardBin;
|
||||
'costEstimateAmount'?: Amount;
|
||||
/**
|
||||
* The result of the cost estimation.
|
||||
*/
|
||||
'resultCode'?: string;
|
||||
/**
|
||||
* Indicates the way the charges can be passed on to the cardholder. The following values are possible: * `ZERO` - the charges are not allowed to pass on * `PASSTHROUGH` - the charges can be passed on * `UNLIMITED` - there is no limit on how much surcharge is passed on
|
||||
*/
|
||||
'surchargeType'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "cardBin",
|
||||
"baseName": "cardBin",
|
||||
"type": "CardBin"
|
||||
},
|
||||
{
|
||||
"name": "costEstimateAmount",
|
||||
"baseName": "costEstimateAmount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "resultCode",
|
||||
"baseName": "resultCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "surchargeType",
|
||||
"baseName": "surchargeType",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return CostEstimateResponse.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class DSPublicKeyDetail {
|
||||
/**
|
||||
* Card brand.
|
||||
*/
|
||||
'brand'?: string;
|
||||
/**
|
||||
* Directory Server (DS) identifier.
|
||||
*/
|
||||
'directoryServerId'?: string;
|
||||
/**
|
||||
* Public key. The 3D Secure 2 SDK encrypts the device information by using the DS public key.
|
||||
*/
|
||||
'publicKey'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "brand",
|
||||
"baseName": "brand",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "directoryServerId",
|
||||
"baseName": "directoryServerId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "publicKey",
|
||||
"baseName": "publicKey",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return DSPublicKeyDetail.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
export * from './amount';
|
||||
export * from './cardBin';
|
||||
export * from './costEstimateAssumptions';
|
||||
export * from './costEstimateRequest';
|
||||
export * from './costEstimateResponse';
|
||||
export * from './dSPublicKeyDetail';
|
||||
export * from './merchantDetails';
|
||||
export * from './recurring';
|
||||
export * from './threeDS2CardRangeDetail';
|
||||
export * from './threeDSAvailabilityRequest';
|
||||
export * from './threeDSAvailabilityResponse';
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class MerchantDetails {
|
||||
/**
|
||||
* 2-letter ISO 3166 country code of the card acceptor location. > This parameter is required for the merchants who don\'t use Adyen as the payment authorisation gateway.
|
||||
*/
|
||||
'countryCode'?: string;
|
||||
/**
|
||||
* If true, indicates that the merchant is enrolled in 3D Secure for the card network.
|
||||
*/
|
||||
'enrolledIn3DSecure'?: boolean;
|
||||
/**
|
||||
* The 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. The list of MCCs can be found [here](https://en.wikipedia.org/wiki/Merchant_category_code).
|
||||
*/
|
||||
'mcc'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "countryCode",
|
||||
"baseName": "countryCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enrolledIn3DSecure",
|
||||
"baseName": "enrolledIn3DSecure",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "mcc",
|
||||
"baseName": "mcc",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return MerchantDetails.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,80 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Recurring {
|
||||
/**
|
||||
* 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).
|
||||
*/
|
||||
'contract'?: Recurring.ContractEnum;
|
||||
/**
|
||||
* A descriptive name for this detail.
|
||||
*/
|
||||
'recurringDetailName'?: string;
|
||||
/**
|
||||
* Date after which no further authorisations shall be performed. Only for 3D Secure 2.
|
||||
*/
|
||||
'recurringExpiry'?: Date;
|
||||
/**
|
||||
* Minimum number of days between authorisations. Only for 3D Secure 2.
|
||||
*/
|
||||
'recurringFrequency'?: string;
|
||||
/**
|
||||
* The name of the token service.
|
||||
*/
|
||||
'tokenService'?: Recurring.TokenServiceEnum;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "contract",
|
||||
"baseName": "contract",
|
||||
"type": "Recurring.ContractEnum"
|
||||
},
|
||||
{
|
||||
"name": "recurringDetailName",
|
||||
"baseName": "recurringDetailName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "recurringExpiry",
|
||||
"baseName": "recurringExpiry",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "recurringFrequency",
|
||||
"baseName": "recurringFrequency",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "tokenService",
|
||||
"baseName": "tokenService",
|
||||
"type": "Recurring.TokenServiceEnum"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Recurring.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace Recurring {
|
||||
export enum ContractEnum {
|
||||
ONECLICK = <any> 'ONECLICK',
|
||||
RECURRING = <any> 'RECURRING',
|
||||
PAYOUT = <any> 'PAYOUT'
|
||||
}
|
||||
export enum TokenServiceEnum {
|
||||
VISATOKENSERVICE = <any> 'VISATOKENSERVICE',
|
||||
MCTOKENSERVICE = <any> 'MCTOKENSERVICE'
|
||||
}
|
||||
}
|
||||
@@ -1,69 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class ThreeDS2CardRangeDetail {
|
||||
/**
|
||||
* Card brand.
|
||||
*/
|
||||
'brandCode'?: string;
|
||||
/**
|
||||
* BIN end range.
|
||||
*/
|
||||
'endRange'?: string;
|
||||
/**
|
||||
* BIN start range.
|
||||
*/
|
||||
'startRange'?: string;
|
||||
/**
|
||||
* 3D Secure protocol version.
|
||||
*/
|
||||
'threeDS2Version'?: string;
|
||||
/**
|
||||
* In a 3D Secure 2 browser-based flow, this is the URL where you should send the device fingerprint to.
|
||||
*/
|
||||
'threeDSMethodURL'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "brandCode",
|
||||
"baseName": "brandCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "endRange",
|
||||
"baseName": "endRange",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "startRange",
|
||||
"baseName": "startRange",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "threeDS2Version",
|
||||
"baseName": "threeDS2Version",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "threeDSMethodURL",
|
||||
"baseName": "threeDSMethodURL",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return ThreeDS2CardRangeDetail.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,78 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class ThreeDSAvailabilityRequest {
|
||||
/**
|
||||
* 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. For more information on possible key-value pairs, refer to the [additionalData section](https://docs.adyen.com/api-reference/payments-api/paymentrequest/paymentrequest-additionaldata).
|
||||
*/
|
||||
'additionalData'?: object;
|
||||
/**
|
||||
* List of brands.
|
||||
*/
|
||||
'brands': Array<string>;
|
||||
/**
|
||||
* Card number or BIN.
|
||||
*/
|
||||
'cardNumber'?: string;
|
||||
/**
|
||||
* The merchant account identifier.
|
||||
*/
|
||||
'merchantAccount': string;
|
||||
/**
|
||||
* A recurring detail reference corresponding to a card.
|
||||
*/
|
||||
'recurringDetailReference'?: string;
|
||||
/**
|
||||
* The shopper\'s reference to uniquely identify this shopper (e.g. user ID or account ID).
|
||||
*/
|
||||
'shopperReference'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "additionalData",
|
||||
"baseName": "additionalData",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "brands",
|
||||
"baseName": "brands",
|
||||
"type": "Array<string>"
|
||||
},
|
||||
{
|
||||
"name": "cardNumber",
|
||||
"baseName": "cardNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantAccount",
|
||||
"baseName": "merchantAccount",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "recurringDetailReference",
|
||||
"baseName": "recurringDetailReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperReference",
|
||||
"baseName": "shopperReference",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return ThreeDSAvailabilityRequest.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,69 +0,0 @@
|
||||
/**
|
||||
* Adyen BinLookup API
|
||||
* The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.
|
||||
*
|
||||
* The version of the OpenAPI document: 50
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { BinDetail } from './binDetail';
|
||||
import { DSPublicKeyDetail } from './dSPublicKeyDetail';
|
||||
import { ThreeDS2CardRangeDetail } from './threeDS2CardRangeDetail';
|
||||
|
||||
export class ThreeDSAvailabilityResponse {
|
||||
'binDetails'?: BinDetail;
|
||||
/**
|
||||
* List of Directory Server (DS) public keys.
|
||||
*/
|
||||
'dsPublicKeys'?: Array<DSPublicKeyDetail>;
|
||||
/**
|
||||
* Indicator if 3D Secure 1 is supported.
|
||||
*/
|
||||
'threeDS1Supported'?: boolean;
|
||||
/**
|
||||
* List of brand and card range pairs.
|
||||
*/
|
||||
'threeDS2CardRangeDetails'?: Array<ThreeDS2CardRangeDetail>;
|
||||
/**
|
||||
* Indicator if 3D Secure 2 is supported.
|
||||
*/
|
||||
'threeDS2supported'?: boolean;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "binDetails",
|
||||
"baseName": "binDetails",
|
||||
"type": "BinDetail"
|
||||
},
|
||||
{
|
||||
"name": "dsPublicKeys",
|
||||
"baseName": "dsPublicKeys",
|
||||
"type": "Array<DSPublicKeyDetail>"
|
||||
},
|
||||
{
|
||||
"name": "threeDS1Supported",
|
||||
"baseName": "threeDS1Supported",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "threeDS2CardRangeDetails",
|
||||
"baseName": "threeDS2CardRangeDetails",
|
||||
"type": "Array<ThreeDS2CardRangeDetail>"
|
||||
},
|
||||
{
|
||||
"name": "threeDS2supported",
|
||||
"baseName": "threeDS2supported",
|
||||
"type": "boolean"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return ThreeDSAvailabilityResponse.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
3528
src/typings/checkout.ts
Normal file
3528
src/typings/checkout.ts
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,235 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AccountInfo {
|
||||
/**
|
||||
* Indicator for the length of time since this shopper account was created in the merchant\'s environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
|
||||
*/
|
||||
'accountAgeIndicator'?: AccountInfo.AccountAgeIndicatorEnum;
|
||||
/**
|
||||
* Date when the shopper\'s account was last changed.
|
||||
*/
|
||||
'accountChangeDate'?: Date;
|
||||
/**
|
||||
* Indicator for the length of time since the shopper\'s account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
|
||||
*/
|
||||
'accountChangeIndicator'?: AccountInfo.AccountChangeIndicatorEnum;
|
||||
/**
|
||||
* Date when the shopper\'s account was created.
|
||||
*/
|
||||
'accountCreationDate'?: Date;
|
||||
/**
|
||||
* Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit
|
||||
*/
|
||||
'accountType'?: AccountInfo.AccountTypeEnum;
|
||||
/**
|
||||
* Number of attempts the shopper tried to add a card to their account in the last day.
|
||||
*/
|
||||
'addCardAttemptsDay'?: number;
|
||||
/**
|
||||
* Date the selected delivery address was first used.
|
||||
*/
|
||||
'deliveryAddressUsageDate'?: Date;
|
||||
/**
|
||||
* Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
|
||||
*/
|
||||
'deliveryAddressUsageIndicator'?: AccountInfo.DeliveryAddressUsageIndicatorEnum;
|
||||
/**
|
||||
* Shopper\'s home phone number (including the country code).
|
||||
*/
|
||||
'homePhone'?: string;
|
||||
/**
|
||||
* Shopper\'s mobile phone number (including the country code).
|
||||
*/
|
||||
'mobilePhone'?: string;
|
||||
/**
|
||||
* Date when the shopper last changed their password.
|
||||
*/
|
||||
'passwordChangeDate'?: Date;
|
||||
/**
|
||||
* Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
|
||||
*/
|
||||
'passwordChangeIndicator'?: AccountInfo.PasswordChangeIndicatorEnum;
|
||||
/**
|
||||
* Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.
|
||||
*/
|
||||
'pastTransactionsDay'?: number;
|
||||
/**
|
||||
* Number of all transactions (successful and abandoned) from this shopper in the past year.
|
||||
*/
|
||||
'pastTransactionsYear'?: number;
|
||||
/**
|
||||
* Date this payment method was added to the shopper\'s account.
|
||||
*/
|
||||
'paymentAccountAge'?: Date;
|
||||
/**
|
||||
* Indicator for the length of time since this payment method was added to this shopper\'s account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
|
||||
*/
|
||||
'paymentAccountIndicator'?: AccountInfo.PaymentAccountIndicatorEnum;
|
||||
/**
|
||||
* Number of successful purchases in the last six months.
|
||||
*/
|
||||
'purchasesLast6Months'?: number;
|
||||
/**
|
||||
* Whether suspicious activity was recorded on this account.
|
||||
*/
|
||||
'suspiciousActivity'?: boolean;
|
||||
/**
|
||||
* Shopper\'s work phone number (including the country code).
|
||||
*/
|
||||
'workPhone'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "accountAgeIndicator",
|
||||
"baseName": "accountAgeIndicator",
|
||||
"type": "AccountInfo.AccountAgeIndicatorEnum"
|
||||
},
|
||||
{
|
||||
"name": "accountChangeDate",
|
||||
"baseName": "accountChangeDate",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "accountChangeIndicator",
|
||||
"baseName": "accountChangeIndicator",
|
||||
"type": "AccountInfo.AccountChangeIndicatorEnum"
|
||||
},
|
||||
{
|
||||
"name": "accountCreationDate",
|
||||
"baseName": "accountCreationDate",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "accountType",
|
||||
"baseName": "accountType",
|
||||
"type": "AccountInfo.AccountTypeEnum"
|
||||
},
|
||||
{
|
||||
"name": "addCardAttemptsDay",
|
||||
"baseName": "addCardAttemptsDay",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "deliveryAddressUsageDate",
|
||||
"baseName": "deliveryAddressUsageDate",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "deliveryAddressUsageIndicator",
|
||||
"baseName": "deliveryAddressUsageIndicator",
|
||||
"type": "AccountInfo.DeliveryAddressUsageIndicatorEnum"
|
||||
},
|
||||
{
|
||||
"name": "homePhone",
|
||||
"baseName": "homePhone",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "mobilePhone",
|
||||
"baseName": "mobilePhone",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "passwordChangeDate",
|
||||
"baseName": "passwordChangeDate",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "passwordChangeIndicator",
|
||||
"baseName": "passwordChangeIndicator",
|
||||
"type": "AccountInfo.PasswordChangeIndicatorEnum"
|
||||
},
|
||||
{
|
||||
"name": "pastTransactionsDay",
|
||||
"baseName": "pastTransactionsDay",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "pastTransactionsYear",
|
||||
"baseName": "pastTransactionsYear",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "paymentAccountAge",
|
||||
"baseName": "paymentAccountAge",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "paymentAccountIndicator",
|
||||
"baseName": "paymentAccountIndicator",
|
||||
"type": "AccountInfo.PaymentAccountIndicatorEnum"
|
||||
},
|
||||
{
|
||||
"name": "purchasesLast6Months",
|
||||
"baseName": "purchasesLast6Months",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "suspiciousActivity",
|
||||
"baseName": "suspiciousActivity",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "workPhone",
|
||||
"baseName": "workPhone",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AccountInfo.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace AccountInfo {
|
||||
export enum AccountAgeIndicatorEnum {
|
||||
NotApplicable = <any> 'notApplicable',
|
||||
ThisTransaction = <any> 'thisTransaction',
|
||||
LessThan30Days = <any> 'lessThan30Days',
|
||||
From30To60Days = <any> 'from30To60Days',
|
||||
MoreThan60Days = <any> 'moreThan60Days'
|
||||
}
|
||||
export enum AccountChangeIndicatorEnum {
|
||||
ThisTransaction = <any> 'thisTransaction',
|
||||
LessThan30Days = <any> 'lessThan30Days',
|
||||
From30To60Days = <any> 'from30To60Days',
|
||||
MoreThan60Days = <any> 'moreThan60Days'
|
||||
}
|
||||
export enum AccountTypeEnum {
|
||||
NotApplicable = <any> 'notApplicable',
|
||||
Credit = <any> 'credit',
|
||||
Debit = <any> 'debit'
|
||||
}
|
||||
export enum DeliveryAddressUsageIndicatorEnum {
|
||||
ThisTransaction = <any> 'thisTransaction',
|
||||
LessThan30Days = <any> 'lessThan30Days',
|
||||
From30To60Days = <any> 'from30To60Days',
|
||||
MoreThan60Days = <any> 'moreThan60Days'
|
||||
}
|
||||
export enum PasswordChangeIndicatorEnum {
|
||||
NotApplicable = <any> 'notApplicable',
|
||||
ThisTransaction = <any> 'thisTransaction',
|
||||
LessThan30Days = <any> 'lessThan30Days',
|
||||
From30To60Days = <any> 'from30To60Days',
|
||||
MoreThan60Days = <any> 'moreThan60Days'
|
||||
}
|
||||
export enum PaymentAccountIndicatorEnum {
|
||||
NotApplicable = <any> 'notApplicable',
|
||||
ThisTransaction = <any> 'thisTransaction',
|
||||
LessThan30Days = <any> 'lessThan30Days',
|
||||
From30To60Days = <any> 'from30To60Days',
|
||||
MoreThan60Days = <any> 'moreThan60Days'
|
||||
}
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalData3DSecure {
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'allow3DS2'?: string;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'executeThreeD'?: string;
|
||||
/**
|
||||
* In case of Secure+, this field must be set to **CUPSecurePlus**.
|
||||
*/
|
||||
'mpiImplementationType'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "allow3DS2",
|
||||
"baseName": "allow3DS2",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "executeThreeD",
|
||||
"baseName": "executeThreeD",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "mpiImplementationType",
|
||||
"baseName": "mpiImplementationType",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalData3DSecure.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,267 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataAirline {
|
||||
/**
|
||||
* Passenger name, initials, and a title. * Format: last name + first name or initials + title. * Example: *FLYER / MARY MS*. * minLength: 1 * maxLength: 49
|
||||
*/
|
||||
'airlinePassengerName'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* [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;
|
||||
/**
|
||||
* The ticket\'s unique identifier. * minLength: 1 * maxLength: 150
|
||||
*/
|
||||
'airlineTicketNumber'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Reference number; alphanumeric. * minLength: 0 * maxLength: 20
|
||||
*/
|
||||
'airlineCustomerReferenceNumber'?: string;
|
||||
/**
|
||||
* Address of the place/agency that issued the ticket. * minLength: 0 * maxLength: 16
|
||||
*/
|
||||
'airlineTicketIssueAddress'?: string;
|
||||
/**
|
||||
* [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;
|
||||
/**
|
||||
* IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies. * minLength: 1 * maxLength: 8
|
||||
*/
|
||||
'airlineTravelAgencyCode'?: string;
|
||||
/**
|
||||
* The name of the travel agency. * minLength: 1 * maxLength: 25
|
||||
*/
|
||||
'airlineTravelAgencyName'?: string;
|
||||
/**
|
||||
* 2-letter agency plan identifier; alphabetical. * minLength: 2 * maxLength: 2
|
||||
*/
|
||||
'airlineAgencyPlanName'?: string;
|
||||
/**
|
||||
* Reference number for the invoice, issued by the agency. * minLength: 1 * maxLength: 6
|
||||
*/
|
||||
'airlineAgencyInvoiceNumber'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The flight identifier. * minLength: 1 * maxLength: 5
|
||||
*/
|
||||
'airlineLegFlightNumber'?: string;
|
||||
/**
|
||||
* [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;
|
||||
/**
|
||||
* [Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric. * minLength: 1 * maxLength: 7
|
||||
*/
|
||||
'airlineLegFareBaseCode'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* [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;
|
||||
/**
|
||||
* Passenger first name/given name. > This field is required/mandatory if the airline data includes passenger details or leg details.
|
||||
*/
|
||||
'airlinePassengerFirstName'?: string;
|
||||
/**
|
||||
* Passenger last name/family name. > This field is required/mandatory if the airline data includes passenger details or leg details.
|
||||
*/
|
||||
'airlinePassengerLastName'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Date of birth of the passenger. Date format: `yyyy-MM-dd` * minLength: 10 * maxLength: 10
|
||||
*/
|
||||
'airlinePassengerDateOfBirth'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "airlinePassengerName",
|
||||
"baseName": "airline.passenger_name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineComputerizedReservationSystem",
|
||||
"baseName": "airline.computerized_reservation_system",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineAirlineCode",
|
||||
"baseName": "airline.airline_code",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineTicketNumber",
|
||||
"baseName": "airline.ticket_number",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineFlightDate",
|
||||
"baseName": "airline.flight_date",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineCustomerReferenceNumber",
|
||||
"baseName": "airline.customer_reference_number",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineTicketIssueAddress",
|
||||
"baseName": "airline.ticket_issue_address",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineAirlineDesignatorCode",
|
||||
"baseName": "airline.airline_designator_code",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineTravelAgencyCode",
|
||||
"baseName": "airline.travel_agency_code",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineTravelAgencyName",
|
||||
"baseName": "airline.travel_agency_name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineAgencyPlanName",
|
||||
"baseName": "airline.agency_plan_name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineAgencyInvoiceNumber",
|
||||
"baseName": "airline.agency_invoice_number",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineBoardingFee",
|
||||
"baseName": "airline.boarding_fee",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineLegDepartAirport",
|
||||
"baseName": "airline.leg.depart_airport",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineLegFlightNumber",
|
||||
"baseName": "airline.leg.flight_number",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineLegCarrierCode",
|
||||
"baseName": "airline.leg.carrier_code",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineLegFareBaseCode",
|
||||
"baseName": "airline.leg.fare_base_code",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineLegClassOfTravel",
|
||||
"baseName": "airline.leg.class_of_travel",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineLegStopOverCode",
|
||||
"baseName": "airline.leg.stop_over_code",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineLegDestinationCode",
|
||||
"baseName": "airline.leg.destination_code",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineLegDateOfTravel",
|
||||
"baseName": "airline.leg.date_of_travel",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlineLegDepartTax",
|
||||
"baseName": "airline.leg.depart_tax",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlinePassengerFirstName",
|
||||
"baseName": "airline.passenger.first_name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlinePassengerLastName",
|
||||
"baseName": "airline.passenger.last_name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlinePassengerTravellerType",
|
||||
"baseName": "airline.passenger.traveller_type",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlinePassengerTelephoneNumber",
|
||||
"baseName": "airline.passenger.telephone_number",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "airlinePassengerDateOfBirth",
|
||||
"baseName": "airline.passenger.date_of_birth",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataAirline.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,231 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataCarRental {
|
||||
/**
|
||||
* The rental agreement number associated with this car rental. * Format: Alphanumeric * maxLength: 14
|
||||
*/
|
||||
'carRentalRentalAgreementNumber'?: string;
|
||||
/**
|
||||
* The name of the person renting the car. * Format: Alphanumeric * maxLength: 26
|
||||
*/
|
||||
'carRentalRenterName'?: string;
|
||||
/**
|
||||
* The city where the car must be returned. * Format: Alphanumeric * maxLength: 18
|
||||
*/
|
||||
'carRentalReturnCity'?: string;
|
||||
/**
|
||||
* The state or province where the car must be returned. * Format: Alphanumeric * maxLength: 3
|
||||
*/
|
||||
'carRentalReturnStateProvince'?: string;
|
||||
/**
|
||||
* The country where the car must be returned. * Format: Alphanumeric * maxLength: 2
|
||||
*/
|
||||
'carRentalReturnCountry'?: string;
|
||||
/**
|
||||
* Agency code, phone number, or address abbreviation * Format: Alphanumeric * maxLength: 10
|
||||
*/
|
||||
'carRentalReturnLocationId'?: string;
|
||||
/**
|
||||
* The last date to return the car by. * Date format: `yyyyMMdd`
|
||||
*/
|
||||
'carRentalReturnDate'?: string;
|
||||
/**
|
||||
* Pick-up date. * Date format: `yyyyMMdd`
|
||||
*/
|
||||
'carRentalCheckOutDate'?: string;
|
||||
/**
|
||||
* The customer service phone number of the car rental company. * Format: Alphanumeric * maxLength: 17
|
||||
*/
|
||||
'carRentalCustomerServiceTollFreeNumber'?: string;
|
||||
/**
|
||||
* Daily rental rate. * Format: Alphanumeric * maxLength: 12
|
||||
*/
|
||||
'carRentalRate'?: string;
|
||||
/**
|
||||
* Specifies whether the given rate is applied daily or weekly. * D - Daily rate. * W - Weekly rate.
|
||||
*/
|
||||
'carRentalRateIndicator'?: string;
|
||||
/**
|
||||
* The location from which the car is rented. * Format: Alphanumeric * maxLength: 18
|
||||
*/
|
||||
'carRentalLocationCity'?: string;
|
||||
/**
|
||||
* Pick-up date. * Date format: `yyyyMMdd`
|
||||
*/
|
||||
'carRentalLocationStateProvince'?: string;
|
||||
/**
|
||||
* The customer service phone number of the car rental company. * Format: Alphanumeric * maxLength: 17
|
||||
*/
|
||||
'carRentalLocationCountry'?: string;
|
||||
/**
|
||||
* Daily rental rate. * Format: Alphanumeric * maxLength: 12
|
||||
*/
|
||||
'carRentalRentalClassId'?: string;
|
||||
/**
|
||||
* Specifies whether the given rate is applied daily or weekly. * D - Daily rate. * W - Weekly rate.
|
||||
*/
|
||||
'carRentalDaysRented'?: string;
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
'carRentalTaxExemptIndicator'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Number of nights. This should be included in the auth message. * Format: Numeric * maxLength: 2
|
||||
*/
|
||||
'travelEntertainmentAuthDataDuration'?: string;
|
||||
/**
|
||||
* Any fuel charges associated with the rental. * Format: Numeric * maxLength: 12
|
||||
*/
|
||||
'carRentalFuelCharges'?: string;
|
||||
/**
|
||||
* Any insurance charges associated with the rental. * Format: Numeric * maxLength: 12
|
||||
*/
|
||||
'carRentalInsuranceCharges'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Charge associated with not returning a vehicle to the original rental location.
|
||||
*/
|
||||
'carRentalOneWayDropOffCharges'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "carRentalRentalAgreementNumber",
|
||||
"baseName": "carRental.rentalAgreementNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalRenterName",
|
||||
"baseName": "carRental.renterName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalReturnCity",
|
||||
"baseName": "carRental.returnCity",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalReturnStateProvince",
|
||||
"baseName": "carRental.returnStateProvince",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalReturnCountry",
|
||||
"baseName": "carRental.returnCountry",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalReturnLocationId",
|
||||
"baseName": "carRental.returnLocationId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalReturnDate",
|
||||
"baseName": "carRental.returnDate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalCheckOutDate",
|
||||
"baseName": "carRental.checkOutDate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalCustomerServiceTollFreeNumber",
|
||||
"baseName": "carRental.customerServiceTollFreeNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalRate",
|
||||
"baseName": "carRental.rate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalRateIndicator",
|
||||
"baseName": "carRental.rateIndicator",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalLocationCity",
|
||||
"baseName": "carRental.locationCity",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalLocationStateProvince",
|
||||
"baseName": "carRental.locationStateProvince",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalLocationCountry",
|
||||
"baseName": "carRental.locationCountry",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalRentalClassId",
|
||||
"baseName": "carRental.rentalClassId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalDaysRented",
|
||||
"baseName": "carRental.daysRented",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalTaxExemptIndicator",
|
||||
"baseName": "carRental.taxExemptIndicator",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "travelEntertainmentAuthDataMarket",
|
||||
"baseName": "travelEntertainmentAuthData.market",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "travelEntertainmentAuthDataDuration",
|
||||
"baseName": "travelEntertainmentAuthData.duration",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalFuelCharges",
|
||||
"baseName": "carRental.fuelCharges",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalInsuranceCharges",
|
||||
"baseName": "carRental.insuranceCharges",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalNoShowIndicator",
|
||||
"baseName": "carRental.noShowIndicator",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "carRentalOneWayDropOffCharges",
|
||||
"baseName": "carRental.oneWayDropOffCharges",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataCarRental.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,78 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataCommon {
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'subMerchantID'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "authorisationType",
|
||||
"baseName": "authorisationType",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "customRoutingFlag",
|
||||
"baseName": "customRoutingFlag",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "networkTxReference",
|
||||
"baseName": "networkTxReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "overwriteBrand",
|
||||
"baseName": "overwriteBrand",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "requestedTestErrorResponseCode",
|
||||
"baseName": "RequestedTestErrorResponseCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "subMerchantID",
|
||||
"baseName": "subMerchantID",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataCommon.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,177 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataLevel23 {
|
||||
/**
|
||||
* Customer code, if supplied by a customer. Encoding: ASCII. Max length: 25 characters. > Required for Level 2 and Level 3 data.
|
||||
*/
|
||||
'enhancedSchemeDataCustomerReference'?: string;
|
||||
/**
|
||||
* 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'?: number;
|
||||
/**
|
||||
* Shipping amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters.
|
||||
*/
|
||||
'enhancedSchemeDataFreightAmount'?: number;
|
||||
/**
|
||||
* Duty amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters.
|
||||
*/
|
||||
'enhancedSchemeDataDutyAmount'?: number;
|
||||
/**
|
||||
* The postal code of a destination address. Encoding: ASCII. Max length: 10 characters. > Required for American Express.
|
||||
*/
|
||||
'enhancedSchemeDataDestinationPostalCode'?: string;
|
||||
/**
|
||||
* Destination state or province code. Encoding: ASCII.Max length: 3 characters.
|
||||
*/
|
||||
'enhancedSchemeDataDestinationStateProvinceCode'?: string;
|
||||
/**
|
||||
* The postal code of a \"ship-from\" address. Encoding: ASCII. Max length: 10 characters.
|
||||
*/
|
||||
'enhancedSchemeDataShipFromPostalCode'?: string;
|
||||
/**
|
||||
* Destination country code. Encoding: ASCII. Max length: 3 characters.
|
||||
*/
|
||||
'enhancedSchemeDataDestinationCountryCode'?: string;
|
||||
/**
|
||||
* Order date. * Format: `ddMMyy` Encoding: ASCII. Max length: 6 characters.
|
||||
*/
|
||||
'enhancedSchemeDataOrderDate'?: string;
|
||||
/**
|
||||
* Item commodity code. Encoding: ASCII. Max length: 12 characters.
|
||||
*/
|
||||
'enhancedSchemeDataItemDetailLineItemNrCommodityCode'?: string;
|
||||
/**
|
||||
* Item description. Encoding: ASCII. Max length: 26 characters.
|
||||
*/
|
||||
'enhancedSchemeDataItemDetailLineItemNrDescription'?: string;
|
||||
/**
|
||||
* Product code. Encoding: ASCII. Max length: 12 characters.
|
||||
*/
|
||||
'enhancedSchemeDataItemDetailLineItemNrProductCode'?: string;
|
||||
/**
|
||||
* Quantity, specified as an integer value. Value must be greater than 0. Max length: 12 characters.
|
||||
*/
|
||||
'enhancedSchemeDataItemDetailLineItemNrQuantity'?: number;
|
||||
/**
|
||||
* Item unit of measurement. Encoding: ASCII. Max length: 3 characters.
|
||||
*/
|
||||
'enhancedSchemeDataItemDetailLineItemNrUnitOfMeasure'?: string;
|
||||
/**
|
||||
* Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). Max length: 12 characters.
|
||||
*/
|
||||
'enhancedSchemeDataItemDetailLineItemNrUnitPrice'?: number;
|
||||
/**
|
||||
* Discount amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters.
|
||||
*/
|
||||
'enhancedSchemeDataItemDetailLineItemNrDiscountAmount'?: number;
|
||||
/**
|
||||
* Total amount, in minor units. For example, 2000 means USD 20.00. Max length: 12 characters.
|
||||
*/
|
||||
'enhancedSchemeDataItemDetailLineItemNrTotalAmount'?: number;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "enhancedSchemeDataCustomerReference",
|
||||
"baseName": "enhancedSchemeData.customerReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataTotalTaxAmount",
|
||||
"baseName": "enhancedSchemeData.totalTaxAmount",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataFreightAmount",
|
||||
"baseName": "enhancedSchemeData.freightAmount",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataDutyAmount",
|
||||
"baseName": "enhancedSchemeData.dutyAmount",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataDestinationPostalCode",
|
||||
"baseName": "enhancedSchemeData.destinationPostalCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataDestinationStateProvinceCode",
|
||||
"baseName": "enhancedSchemeData.destinationStateProvinceCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataShipFromPostalCode",
|
||||
"baseName": "enhancedSchemeData.shipFromPostalCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataDestinationCountryCode",
|
||||
"baseName": "enhancedSchemeData.destinationCountryCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataOrderDate",
|
||||
"baseName": "enhancedSchemeData.orderDate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataItemDetailLineItemNrCommodityCode",
|
||||
"baseName": "enhancedSchemeData.itemDetailLine[itemNr].commodityCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataItemDetailLineItemNrDescription",
|
||||
"baseName": "enhancedSchemeData.itemDetailLine[itemNr].description",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataItemDetailLineItemNrProductCode",
|
||||
"baseName": "enhancedSchemeData.itemDetailLine[itemNr].productCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataItemDetailLineItemNrQuantity",
|
||||
"baseName": "enhancedSchemeData.itemDetailLine[itemNr].quantity",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataItemDetailLineItemNrUnitOfMeasure",
|
||||
"baseName": "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataItemDetailLineItemNrUnitPrice",
|
||||
"baseName": "enhancedSchemeData.itemDetailLine[itemNr].unitPrice",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataItemDetailLineItemNrDiscountAmount",
|
||||
"baseName": "enhancedSchemeData.itemDetailLine[itemNr].discountAmount",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataItemDetailLineItemNrTotalAmount",
|
||||
"baseName": "enhancedSchemeData.itemDetailLine[itemNr].totalAmount",
|
||||
"type": "number"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataLevel23.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,177 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataLodging {
|
||||
/**
|
||||
* The toll free phone number for the hotel/lodgings. * Format: Alphanumeric * maxLength: 17
|
||||
*/
|
||||
'lodgingCustomerServiceTollFreeNumber'?: string;
|
||||
/**
|
||||
* The arrival date. * Date format: `yyyyMMdd`
|
||||
*/
|
||||
'lodgingCheckInDate'?: string;
|
||||
/**
|
||||
* The departure date. * Date format: `yyyyMMdd`
|
||||
*/
|
||||
'lodgingCheckOutDate'?: string;
|
||||
/**
|
||||
* Card acceptor’s internal invoice or billing ID reference number. * Format: Alphanumeric * maxLength: 25
|
||||
*/
|
||||
'lodgingFolioNumber'?: string;
|
||||
/**
|
||||
* Identifies specific lodging property location by its local phone number. * Format: Alphanumeric * maxLength: 17
|
||||
*/
|
||||
'lodgingPropertyPhoneNumber'?: string;
|
||||
/**
|
||||
* The rate of the room. * Format: Numeric * maxLength: 12
|
||||
*/
|
||||
'lodgingRoom1Rate'?: string;
|
||||
/**
|
||||
* The total amount of tax to be paid. * Format: Numeric * maxLength: 12
|
||||
*/
|
||||
'lodgingRoom1Tax'?: string;
|
||||
/**
|
||||
* Total number of nights the room will be rented. * Format: Numeric * maxLength: 4
|
||||
*/
|
||||
'lodgingRoom1NumberOfNights'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Number of nights. This should be included in the auth message. * Format: Numeric * maxLength: 2
|
||||
*/
|
||||
'travelEntertainmentAuthDataDuration'?: string;
|
||||
/**
|
||||
* The folio cash advances. * Format: Numeric * maxLength: 12
|
||||
*/
|
||||
'lodgingFolioCashAdvances'?: string;
|
||||
/**
|
||||
* Any charges for food and beverages associated with the booking. * Format: Numeric * maxLength: 12
|
||||
*/
|
||||
'lodgingFoodBeverageCharges'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Prepaid expenses for the booking. * Format: Numeric * maxLength: 12
|
||||
*/
|
||||
'lodgingPrepaidExpenses'?: string;
|
||||
/**
|
||||
* Total tax amount. * Format: Numeric * maxLength: 12
|
||||
*/
|
||||
'lodgingTotalTax'?: string;
|
||||
/**
|
||||
* Total room tax amount. * Format: Numeric * maxLength: 12
|
||||
*/
|
||||
'lodgingTotalRoomTax'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "lodgingCustomerServiceTollFreeNumber",
|
||||
"baseName": "lodging.customerServiceTollFreeNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingCheckInDate",
|
||||
"baseName": "lodging.checkInDate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingCheckOutDate",
|
||||
"baseName": "lodging.checkOutDate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingFolioNumber",
|
||||
"baseName": "lodging.folioNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingPropertyPhoneNumber",
|
||||
"baseName": "lodging.propertyPhoneNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingRoom1Rate",
|
||||
"baseName": "lodging.room1.rate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingRoom1Tax",
|
||||
"baseName": "lodging.room1.tax",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingRoom1NumberOfNights",
|
||||
"baseName": "lodging.room1.numberOfNights",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingFireSafetyActIndicator",
|
||||
"baseName": "lodging.fireSafetyActIndicator",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "travelEntertainmentAuthDataMarket",
|
||||
"baseName": "travelEntertainmentAuthData.market",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "travelEntertainmentAuthDataDuration",
|
||||
"baseName": "travelEntertainmentAuthData.duration",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingFolioCashAdvances",
|
||||
"baseName": "lodging.folioCashAdvances",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingFoodBeverageCharges",
|
||||
"baseName": "lodging.foodBeverageCharges",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingNoShowIndicator",
|
||||
"baseName": "lodging.noShowIndicator",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingPrepaidExpenses",
|
||||
"baseName": "lodging.prepaidExpenses",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingTotalTax",
|
||||
"baseName": "lodging.totalTax",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lodgingTotalRoomTax",
|
||||
"baseName": "lodging.totalRoomTax",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataLodging.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,123 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataOpenInvoice {
|
||||
/**
|
||||
* 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'?: number;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Required for the Klarna account, identifying an installment plan. Include Klarna’s `pclassid` for the installment plan.
|
||||
*/
|
||||
'openinvoicedataInstallmentConfigurationKey'?: string;
|
||||
/**
|
||||
* The three-character ISO currency code.
|
||||
*/
|
||||
'openinvoicedataLineItemNrCurrencyCode'?: string;
|
||||
/**
|
||||
* A text description of the product the invoice line refers to.
|
||||
*/
|
||||
'openinvoicedataLineItemNrDescription'?: string;
|
||||
/**
|
||||
* The price for one item in the invoice line, represented in minor units. The due amount for the item, VAT excluded.
|
||||
*/
|
||||
'openinvoicedataLineItemNrItemAmount'?: number;
|
||||
/**
|
||||
* The VAT due for one item in the invoice line, represented in minor units.
|
||||
*/
|
||||
'openinvoicedataLineItemNrItemVatAmount'?: number;
|
||||
/**
|
||||
* The VAT percentage for one item in the invoice line, represented in minor units. For example, 19% VAT is specified as 1900.
|
||||
*/
|
||||
'openinvoicedataLineItemNrItemVatPercentage'?: number;
|
||||
/**
|
||||
* A unique id for this item. Required for RatePay if the description of each item is not unique.
|
||||
*/
|
||||
'openinvoicedataLineItemNrItemId'?: string;
|
||||
/**
|
||||
* The number of units purchased of a specific product.
|
||||
*/
|
||||
'openinvoicedataLineItemNrNumberOfItems'?: number;
|
||||
/**
|
||||
* The country-specific VAT category a product falls under. Allowed values: * High * Low * None.
|
||||
*/
|
||||
'openinvoicedataLineItemNrVatCategory'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "openinvoicedataNumberOfLines",
|
||||
"baseName": "openinvoicedata.numberOfLines",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "openinvoicedataMerchantData",
|
||||
"baseName": "openinvoicedata.merchantData",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "openinvoicedataInstallmentConfigurationKey",
|
||||
"baseName": "openinvoicedata.installmentConfigurationKey",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "openinvoicedataLineItemNrCurrencyCode",
|
||||
"baseName": "openinvoicedata.line[itemNr].currencyCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "openinvoicedataLineItemNrDescription",
|
||||
"baseName": "openinvoicedata.line[itemNr].description",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "openinvoicedataLineItemNrItemAmount",
|
||||
"baseName": "openinvoicedata.line[itemNr].itemAmount",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "openinvoicedataLineItemNrItemVatAmount",
|
||||
"baseName": "openinvoicedata.line[itemNr].itemVatAmount",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "openinvoicedataLineItemNrItemVatPercentage",
|
||||
"baseName": "openinvoicedata.line[itemNr].itemVatPercentage",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "openinvoicedataLineItemNrItemId",
|
||||
"baseName": "openinvoicedata.line[itemNr].itemId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "openinvoicedataLineItemNrNumberOfItems",
|
||||
"baseName": "openinvoicedata.line[itemNr].numberOfItems",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "openinvoicedataLineItemNrVatCategory",
|
||||
"baseName": "openinvoicedata.line[itemNr].vatCategory",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataOpenInvoice.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,96 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataRatepay {
|
||||
/**
|
||||
* Amount the customer has to pay each month.
|
||||
*/
|
||||
'ratepayInstallmentAmount'?: number;
|
||||
/**
|
||||
* Amount of the last installment.
|
||||
*/
|
||||
'ratepayLastInstallmentAmount'?: number;
|
||||
/**
|
||||
* Interest rate of this installment. Double
|
||||
*/
|
||||
'ratepayInterestRate'?: number;
|
||||
/**
|
||||
* Calendar day of the first payment.
|
||||
*/
|
||||
'ratepayPaymentFirstday'?: number;
|
||||
/**
|
||||
* Identification name or number for the invoice, defined by the merchant.
|
||||
*/
|
||||
'ratepaydataInvoiceId'?: string;
|
||||
/**
|
||||
* Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.
|
||||
*/
|
||||
'ratepaydataInvoiceDate'?: string;
|
||||
/**
|
||||
* Date the merchant delivered the goods to the customer.
|
||||
*/
|
||||
'ratepaydataDeliveryDate'?: string;
|
||||
/**
|
||||
* Date by which the customer must settle the payment.
|
||||
*/
|
||||
'ratepaydataDueDate'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "ratepayInstallmentAmount",
|
||||
"baseName": "ratepay.installmentAmount",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "ratepayLastInstallmentAmount",
|
||||
"baseName": "ratepay.lastInstallmentAmount",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "ratepayInterestRate",
|
||||
"baseName": "ratepay.interestRate",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "ratepayPaymentFirstday",
|
||||
"baseName": "ratepay.paymentFirstday",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "ratepaydataInvoiceId",
|
||||
"baseName": "ratepaydata.invoiceId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "ratepaydataInvoiceDate",
|
||||
"baseName": "ratepaydata.invoiceDate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "ratepaydataDeliveryDate",
|
||||
"baseName": "ratepaydata.deliveryDate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "ratepaydataDueDate",
|
||||
"baseName": "ratepaydata.dueDate",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataRatepay.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataRetry {
|
||||
/**
|
||||
* 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'?: number;
|
||||
/**
|
||||
* 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'?: number;
|
||||
/**
|
||||
* 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'?: boolean;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "retryChainAttemptNumber",
|
||||
"baseName": "retry.chainAttemptNumber",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "retryOrderAttemptNumber",
|
||||
"baseName": "retry.orderAttemptNumber",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "retrySkipRetry",
|
||||
"baseName": "retry.skipRetry",
|
||||
"type": "boolean"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataRetry.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,384 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataRisk {
|
||||
/**
|
||||
* The method to deliver the goods to the shopper. Used in [Delivery Method](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#delivery-method) check.
|
||||
*/
|
||||
'riskdataDeliveryMethod'?: string;
|
||||
/**
|
||||
* The creation date of a shopper account on the merchant\'s platform. * Format: `yyyy-MM-dd HH:mm:ss` Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataAccountCreationDate'?: string;
|
||||
/**
|
||||
* This specifies the date when the shopper\'s account was created. * Format: `yyyy-MM-dd HH:mm:ss.sssZ` Used in [Shopper Account Age check](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#shopper-account-age).
|
||||
*/
|
||||
'riskdataShopperAccountCreationDate'?: string;
|
||||
/**
|
||||
* A risk score coming from a system external to Adyen. * Format: Numeric (when used in custom risk checks) Used in [External Risk Score check](https://docs.adyen.com/risk-management/configure-standard-risk-rules/external-risk-rules#external-risk-score-generic). Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataExternalRiskScore'?: string;
|
||||
/**
|
||||
* Usually a boolean representing the fraud risk assessment coming from a system external to Adyen. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataExternalSuspectedFraud'?: string;
|
||||
/**
|
||||
* A code corresponding to a telecom network operator Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataOperatorCode'?: string;
|
||||
/**
|
||||
* Country corresponding to the telecom network operator. Usually a two letter country code. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataOperatorCountry'?: object;
|
||||
/**
|
||||
* Name of a telecom network operator e.g. Vodafone, Orange etc. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataOperatorName'?: string;
|
||||
/**
|
||||
* Product code of a telecom product. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataOperatorProductCode'?: string;
|
||||
/**
|
||||
* Represents the payment method as it is understood by the merchant. Does not necessarily have to coincide with the payment method determined by Adyen. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules). For visacheckout, masterpass, and paywithgoogle, use `riskdata.paymentDataSource` instead.
|
||||
*/
|
||||
'riskdataPaymentMethod'?: string;
|
||||
/**
|
||||
* Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules) for visacheckout, masterpass, and paywithgoogle.
|
||||
*/
|
||||
'riskdataPaymentDataSource'?: string;
|
||||
/**
|
||||
* The number of previous non-fraudulent orders made by a shopper. * Format: Numeric Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataPreviousSuccessfulOrders'?: string;
|
||||
/**
|
||||
* The referral method/reason for joining the merchant\'s platform. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataReferralMethod'?: string;
|
||||
/**
|
||||
* The user name of a member who referred somebody to the merchant\'s platform. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataReferrerUserName'?: string;
|
||||
/**
|
||||
* The id of the risk profile to use instead of the merchant account\'s currently set risk profile.
|
||||
*/
|
||||
'riskdataRiskProfileId'?: string;
|
||||
/**
|
||||
* A secondary phone number for a user of the merchant\'s platform. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataSecondaryPhoneNumber'?: object;
|
||||
/**
|
||||
* Name of the shipping method. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataShippingMethod'?: string;
|
||||
/**
|
||||
* The shopper country as determined by the merchant, usually as a 2 letter country code. Does not have to coincide with the Adyen determined shopper country. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataShopperCountry'?: string;
|
||||
/**
|
||||
* Usually a SIM distribution company name e.g. Core, Elite, GK Tel etc. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataSimDistributor'?: string;
|
||||
/**
|
||||
* User name of an account on the merchant\'s platform. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataUserName'?: string;
|
||||
/**
|
||||
* Usually a user\'s loyalty status e.g. Gold, Silver etc. Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataUserStatus'?: string;
|
||||
/**
|
||||
* Name of the browser language used by the shopper. Usually a two letter country code (e.g. NL, FR, US etc.) Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).
|
||||
*/
|
||||
'riskdataBrowserLanguage'?: string;
|
||||
/**
|
||||
* ID of the item.
|
||||
*/
|
||||
'riskdataBasketItemItemNrItemID'?: string;
|
||||
/**
|
||||
* A text description of the product the invoice line refers to.
|
||||
*/
|
||||
'riskdataBasketItemItemNrProductTitle'?: string;
|
||||
/**
|
||||
* The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
||||
*/
|
||||
'riskdataBasketItemItemNrAmountPerItem'?: string;
|
||||
/**
|
||||
* The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
|
||||
*/
|
||||
'riskdataBasketItemItemNrCurrency'?: string;
|
||||
/**
|
||||
* [Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).
|
||||
*/
|
||||
'riskdataBasketItemItemNrUpc'?: string;
|
||||
/**
|
||||
* [Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).
|
||||
*/
|
||||
'riskdataBasketItemItemNrSku'?: string;
|
||||
/**
|
||||
* Brand of the item.
|
||||
*/
|
||||
'riskdataBasketItemItemNrBrand'?: string;
|
||||
/**
|
||||
* Manufacturer of the item.
|
||||
*/
|
||||
'riskdataBasketItemItemNrManufacturer'?: string;
|
||||
/**
|
||||
* Category of the item.
|
||||
*/
|
||||
'riskdataBasketItemItemNrCategory'?: string;
|
||||
/**
|
||||
* Color of the item.
|
||||
*/
|
||||
'riskdataBasketItemItemNrColor'?: string;
|
||||
/**
|
||||
* Size of the item.
|
||||
*/
|
||||
'riskdataBasketItemItemNrSize'?: string;
|
||||
/**
|
||||
* Quantity of the item purchased.
|
||||
*/
|
||||
'riskdataBasketItemItemNrQuantity'?: string;
|
||||
/**
|
||||
* Email associated with the given product in the basket (usually in electronic gift cards).
|
||||
*/
|
||||
'riskdataBasketItemItemNrReceiverEmail'?: string;
|
||||
/**
|
||||
* Code of the promotion.
|
||||
*/
|
||||
'riskdataPromotionsPromotionItemNrPromotionCode'?: string;
|
||||
/**
|
||||
* Name of the promotion.
|
||||
*/
|
||||
'riskdataPromotionsPromotionItemNrPromotionName'?: string;
|
||||
/**
|
||||
* The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).
|
||||
*/
|
||||
'riskdataPromotionsPromotionItemNrPromotionDiscountAmount'?: string;
|
||||
/**
|
||||
* The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
|
||||
*/
|
||||
'riskdataPromotionsPromotionItemNrPromotionDiscountCurrency'?: string;
|
||||
/**
|
||||
* 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;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "riskdataDeliveryMethod",
|
||||
"baseName": "riskdata.deliveryMethod",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataAccountCreationDate",
|
||||
"baseName": "riskdata.accountCreationDate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataShopperAccountCreationDate",
|
||||
"baseName": "riskdata.shopperAccountCreationDate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataExternalRiskScore",
|
||||
"baseName": "riskdata.externalRiskScore",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataExternalSuspectedFraud",
|
||||
"baseName": "riskdata.externalSuspectedFraud",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataOperatorCode",
|
||||
"baseName": "riskdata.operatorCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataOperatorCountry",
|
||||
"baseName": "riskdata.operatorCountry",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "riskdataOperatorName",
|
||||
"baseName": "riskdata.operatorName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataOperatorProductCode",
|
||||
"baseName": "riskdata.operatorProductCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataPaymentMethod",
|
||||
"baseName": "riskdata.paymentMethod",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataPaymentDataSource",
|
||||
"baseName": "riskdata.paymentDataSource",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataPreviousSuccessfulOrders",
|
||||
"baseName": "riskdata.previousSuccessfulOrders",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataReferralMethod",
|
||||
"baseName": "riskdata.referralMethod",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataReferrerUserName",
|
||||
"baseName": "riskdata.referrerUserName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataRiskProfileId",
|
||||
"baseName": "riskdata.riskProfileId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataSecondaryPhoneNumber",
|
||||
"baseName": "riskdata.secondaryPhoneNumber",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "riskdataShippingMethod",
|
||||
"baseName": "riskdata.shippingMethod",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataShopperCountry",
|
||||
"baseName": "riskdata.shopperCountry",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataSimDistributor",
|
||||
"baseName": "riskdata.simDistributor",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataUserName",
|
||||
"baseName": "riskdata.userName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataUserStatus",
|
||||
"baseName": "riskdata.userStatus",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBrowserLanguage",
|
||||
"baseName": "riskdata.browserLanguage",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrItemID",
|
||||
"baseName": "riskdata.basket.item[itemNr].itemID",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrProductTitle",
|
||||
"baseName": "riskdata.basket.item[itemNr].productTitle",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrAmountPerItem",
|
||||
"baseName": "riskdata.basket.item[itemNr].amountPerItem",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrCurrency",
|
||||
"baseName": "riskdata.basket.item[itemNr].currency",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrUpc",
|
||||
"baseName": "riskdata.basket.item[itemNr].upc",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrSku",
|
||||
"baseName": "riskdata.basket.item[itemNr].sku",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrBrand",
|
||||
"baseName": "riskdata.basket.item[itemNr].brand",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrManufacturer",
|
||||
"baseName": "riskdata.basket.item[itemNr].manufacturer",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrCategory",
|
||||
"baseName": "riskdata.basket.item[itemNr].category",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrColor",
|
||||
"baseName": "riskdata.basket.item[itemNr].color",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrSize",
|
||||
"baseName": "riskdata.basket.item[itemNr].size",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrQuantity",
|
||||
"baseName": "riskdata.basket.item[itemNr].quantity",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataBasketItemItemNrReceiverEmail",
|
||||
"baseName": "riskdata.basket.item[itemNr].receiverEmail",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataPromotionsPromotionItemNrPromotionCode",
|
||||
"baseName": "riskdata.promotions.promotion[itemNr].promotionCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataPromotionsPromotionItemNrPromotionName",
|
||||
"baseName": "riskdata.promotions.promotion[itemNr].promotionName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataPromotionsPromotionItemNrPromotionDiscountAmount",
|
||||
"baseName": "riskdata.promotions.promotion[itemNr].promotionDiscountAmount",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataPromotionsPromotionItemNrPromotionDiscountCurrency",
|
||||
"baseName": "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskdataPromotionsPromotionItemNrPromotionDiscountPercentage",
|
||||
"baseName": "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataRisk.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,159 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataRiskStandalone {
|
||||
/**
|
||||
* Raw AVS result received from the acquirer, where available. Example: 7
|
||||
*/
|
||||
'avsResultRaw'?: string;
|
||||
/**
|
||||
* The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](/risk-management/standalone-risk#tokenised-pan-request).
|
||||
*/
|
||||
'bin'?: string;
|
||||
/**
|
||||
* Raw CVC result received from the acquirer, where available. Example: 1
|
||||
*/
|
||||
'cvcResultRaw'?: string;
|
||||
/**
|
||||
* Unique identifier or token for the shopper\'s card details.
|
||||
*/
|
||||
'riskToken'?: string;
|
||||
/**
|
||||
* A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true
|
||||
*/
|
||||
'threeDAuthenticated'?: string;
|
||||
/**
|
||||
* A Boolean value indicating whether 3DS was offered for this payment. Example: true
|
||||
*/
|
||||
'threeDOffered'?: string;
|
||||
/**
|
||||
* Required for PayPal payments only. The only supported value is: **paypal**.
|
||||
*/
|
||||
'tokenDataType'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.
|
||||
*/
|
||||
'payPalPayerId'?: string;
|
||||
/**
|
||||
* Unique transaction ID of the payment.
|
||||
*/
|
||||
'payPalTransactionId'?: string;
|
||||
/**
|
||||
* Shopper\'s country of residence in the form of ISO standard 3166 2-character country codes.
|
||||
*/
|
||||
'payPalCountryCode'?: string;
|
||||
/**
|
||||
* Shopper\'s first name.
|
||||
*/
|
||||
'payPalFirstName'?: string;
|
||||
/**
|
||||
* Shopper\'s last name.
|
||||
*/
|
||||
'payPalLastName'?: string;
|
||||
/**
|
||||
* Shopper\'s phone number.
|
||||
*/
|
||||
'payPalPhone'?: string;
|
||||
/**
|
||||
* Shopper\'s email.
|
||||
*/
|
||||
'payPalEmailId'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "avsResultRaw",
|
||||
"baseName": "avsResultRaw",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "bin",
|
||||
"baseName": "bin",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "cvcResultRaw",
|
||||
"baseName": "cvcResultRaw",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "riskToken",
|
||||
"baseName": "risk.token",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "threeDAuthenticated",
|
||||
"baseName": "threeDAuthenticated",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "threeDOffered",
|
||||
"baseName": "threeDOffered",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "tokenDataType",
|
||||
"baseName": "tokenDataType",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "payPalProtectionEligibility",
|
||||
"baseName": "PayPal.ProtectionEligibility",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "payPalPayerId",
|
||||
"baseName": "PayPal.PayerId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "payPalTransactionId",
|
||||
"baseName": "PayPal.TransactionId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "payPalCountryCode",
|
||||
"baseName": "PayPal.CountryCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "payPalFirstName",
|
||||
"baseName": "PayPal.FirstName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "payPalLastName",
|
||||
"baseName": "PayPal.LastName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "payPalPhone",
|
||||
"baseName": "PayPal.Phone",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "payPalEmailId",
|
||||
"baseName": "PayPal.EmailId",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataRiskStandalone.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,105 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataTemporaryServices {
|
||||
/**
|
||||
* Customer code, if supplied by a customer. * Encoding: ASCII * maxLength: 25
|
||||
*/
|
||||
'enhancedSchemeDataCustomerReference'?: string;
|
||||
/**
|
||||
* Total tax amount, in minor units. For example, 2000 means USD 20.00 * maxLength: 12
|
||||
*/
|
||||
'enhancedSchemeDataTotalTaxAmount'?: string;
|
||||
/**
|
||||
* Name or ID associated with the individual working in a temporary capacity. * maxLength: 40
|
||||
*/
|
||||
'enhancedSchemeDataEmployeeName'?: string;
|
||||
/**
|
||||
* Description of the job or task of the individual working in a temporary capacity. * maxLength: 40
|
||||
*/
|
||||
'enhancedSchemeDataJobDescription'?: string;
|
||||
/**
|
||||
* Date for the beginning of the pay period. * Format: ddMMyy * maxLength: 6
|
||||
*/
|
||||
'enhancedSchemeDataTempStartDate'?: string;
|
||||
/**
|
||||
* Date of the end of the billing cycle. * Format: ddMMyy * maxLength: 6
|
||||
*/
|
||||
'enhancedSchemeDataTempWeekEnding'?: string;
|
||||
/**
|
||||
* Name of the individual requesting temporary services. * maxLength: 40
|
||||
*/
|
||||
'enhancedSchemeDataRequestName'?: string;
|
||||
/**
|
||||
* Amount of time worked during a normal operation for the task or job. * maxLength: 7
|
||||
*/
|
||||
'enhancedSchemeDataRegularHoursWorked'?: string;
|
||||
/**
|
||||
* Amount paid per regular hours worked, minor units. * maxLength: 7
|
||||
*/
|
||||
'enhancedSchemeDataRegularHoursRate'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "enhancedSchemeDataCustomerReference",
|
||||
"baseName": "enhancedSchemeData.customerReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataTotalTaxAmount",
|
||||
"baseName": "enhancedSchemeData.totalTaxAmount",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataEmployeeName",
|
||||
"baseName": "enhancedSchemeData.employeeName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataJobDescription",
|
||||
"baseName": "enhancedSchemeData.jobDescription",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataTempStartDate",
|
||||
"baseName": "enhancedSchemeData.tempStartDate",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataTempWeekEnding",
|
||||
"baseName": "enhancedSchemeData.tempWeekEnding",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataRequestName",
|
||||
"baseName": "enhancedSchemeData.requestName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataRegularHoursWorked",
|
||||
"baseName": "enhancedSchemeData.regularHoursWorked",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enhancedSchemeDataRegularHoursRate",
|
||||
"baseName": "enhancedSchemeData.regularHoursRate",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataTemporaryServices.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,78 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class AdditionalDataWallets {
|
||||
/**
|
||||
* The Android Pay token retrieved from the SDK.
|
||||
*/
|
||||
'androidpayToken'?: string;
|
||||
/**
|
||||
* The Mastercard Masterpass Transaction ID retrieved from the SDK.
|
||||
*/
|
||||
'masterpassTransactionId'?: string;
|
||||
/**
|
||||
* The Apple Pay token retrieved from the SDK.
|
||||
*/
|
||||
'paymentToken'?: string;
|
||||
/**
|
||||
* The Google Pay token retrieved from the SDK.
|
||||
*/
|
||||
'paywithgoogleToken'?: string;
|
||||
/**
|
||||
* The Samsung Pay token retrieved from the SDK.
|
||||
*/
|
||||
'samsungpayToken'?: string;
|
||||
/**
|
||||
* The Visa Checkout Call ID retrieved from the SDK.
|
||||
*/
|
||||
'visacheckoutCallId'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "androidpayToken",
|
||||
"baseName": "androidpay.token",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "masterpassTransactionId",
|
||||
"baseName": "masterpass.transactionId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "paymentToken",
|
||||
"baseName": "payment.token",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "paywithgoogleToken",
|
||||
"baseName": "paywithgoogle.token",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "samsungpayToken",
|
||||
"baseName": "samsungpay.token",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "visacheckoutCallId",
|
||||
"baseName": "visacheckout.callId",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return AdditionalDataWallets.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,78 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Address {
|
||||
/**
|
||||
* The name of the city.
|
||||
*/
|
||||
'city': string;
|
||||
/**
|
||||
* 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`.
|
||||
*/
|
||||
'country': string;
|
||||
/**
|
||||
* The number or name of the house.
|
||||
*/
|
||||
'houseNumberOrName': string;
|
||||
/**
|
||||
* A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
|
||||
*/
|
||||
'postalCode': string;
|
||||
/**
|
||||
* State or province codes as defined in ISO 3166-2. For example, **SF** in US or **ON** for Canada. > Required for the US and Canada.
|
||||
*/
|
||||
'stateOrProvince'?: string;
|
||||
/**
|
||||
* The name of the street. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
|
||||
*/
|
||||
'street': string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "city",
|
||||
"baseName": "city",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "country",
|
||||
"baseName": "country",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "houseNumberOrName",
|
||||
"baseName": "houseNumberOrName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "postalCode",
|
||||
"baseName": "postalCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "stateOrProvince",
|
||||
"baseName": "stateOrProvince",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "street",
|
||||
"baseName": "street",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Address.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Amount {
|
||||
/**
|
||||
* The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
|
||||
*/
|
||||
'currency': string;
|
||||
/**
|
||||
* 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).
|
||||
*/
|
||||
'value': number;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "currency",
|
||||
"baseName": "currency",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"baseName": "value",
|
||||
"type": "number"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Amount.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,64 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { CommonField } from './commonField';
|
||||
import { ExternalPlatform } from './externalPlatform';
|
||||
import { MerchantDevice } from './merchantDevice';
|
||||
import { ShopperInteractionDevice } from './shopperInteractionDevice';
|
||||
|
||||
export class ApplicationInfo {
|
||||
'adyenLibrary'?: CommonField;
|
||||
'adyenPaymentSource'?: CommonField;
|
||||
'externalPlatform'?: ExternalPlatform;
|
||||
'merchantApplication'?: CommonField;
|
||||
'merchantDevice'?: MerchantDevice;
|
||||
'shopperInteractionDevice'?: ShopperInteractionDevice;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "adyenLibrary",
|
||||
"baseName": "adyenLibrary",
|
||||
"type": "CommonField"
|
||||
},
|
||||
{
|
||||
"name": "adyenPaymentSource",
|
||||
"baseName": "adyenPaymentSource",
|
||||
"type": "CommonField"
|
||||
},
|
||||
{
|
||||
"name": "externalPlatform",
|
||||
"baseName": "externalPlatform",
|
||||
"type": "ExternalPlatform"
|
||||
},
|
||||
{
|
||||
"name": "merchantApplication",
|
||||
"baseName": "merchantApplication",
|
||||
"type": "CommonField"
|
||||
},
|
||||
{
|
||||
"name": "merchantDevice",
|
||||
"baseName": "merchantDevice",
|
||||
"type": "MerchantDevice"
|
||||
},
|
||||
{
|
||||
"name": "shopperInteractionDevice",
|
||||
"baseName": "shopperInteractionDevice",
|
||||
"type": "ShopperInteractionDevice"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return ApplicationInfo.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Avs {
|
||||
/**
|
||||
* Indicates whether the shopper is allowed to modify the billing address for the current payment request.
|
||||
*/
|
||||
'addressEditable'?: boolean;
|
||||
/**
|
||||
* Specifies whether the shopper should enter their billing address during checkout. 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.
|
||||
*/
|
||||
'enabled'?: Avs.EnabledEnum;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "addressEditable",
|
||||
"baseName": "addressEditable",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "enabled",
|
||||
"baseName": "enabled",
|
||||
"type": "Avs.EnabledEnum"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Avs.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace Avs {
|
||||
export enum EnabledEnum {
|
||||
Yes = <any> 'yes',
|
||||
No = <any> 'no',
|
||||
Automatic = <any> 'automatic'
|
||||
}
|
||||
}
|
||||
@@ -1,105 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class BankAccount {
|
||||
/**
|
||||
* The bank account number (without separators).
|
||||
*/
|
||||
'bankAccountNumber'?: string;
|
||||
/**
|
||||
* The bank city.
|
||||
*/
|
||||
'bankCity'?: string;
|
||||
/**
|
||||
* The location id of the bank. The field value is `nil` in most cases.
|
||||
*/
|
||||
'bankLocationId'?: string;
|
||||
/**
|
||||
* The name of the bank.
|
||||
*/
|
||||
'bankName'?: string;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'bic'?: string;
|
||||
/**
|
||||
* Country code where the bank is located. A valid value is an ISO two-character country code (e.g. \'NL\').
|
||||
*/
|
||||
'countryCode'?: string;
|
||||
/**
|
||||
* The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN).
|
||||
*/
|
||||
'iban'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The bank account holder\'s tax ID.
|
||||
*/
|
||||
'taxId'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "bankAccountNumber",
|
||||
"baseName": "bankAccountNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "bankCity",
|
||||
"baseName": "bankCity",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "bankLocationId",
|
||||
"baseName": "bankLocationId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "bankName",
|
||||
"baseName": "bankName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "bic",
|
||||
"baseName": "bic",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "countryCode",
|
||||
"baseName": "countryCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "iban",
|
||||
"baseName": "iban",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "ownerName",
|
||||
"baseName": "ownerName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "taxId",
|
||||
"baseName": "taxId",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return BankAccount.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,105 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class BrowserInfo {
|
||||
/**
|
||||
* The accept header value of the shopper\'s browser.
|
||||
*/
|
||||
'acceptHeader': string;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'colorDepth': number;
|
||||
/**
|
||||
* Boolean value indicating if the shopper\'s browser is able to execute Java.
|
||||
*/
|
||||
'javaEnabled': boolean;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'javaScriptEnabled'?: boolean;
|
||||
/**
|
||||
* The `navigator.language` value of the shopper\'s browser (as defined in IETF BCP 47).
|
||||
*/
|
||||
'language': string;
|
||||
/**
|
||||
* The total height of the shopper\'s device screen in pixels.
|
||||
*/
|
||||
'screenHeight': number;
|
||||
/**
|
||||
* The total width of the shopper\'s device screen in pixels.
|
||||
*/
|
||||
'screenWidth': number;
|
||||
/**
|
||||
* Time difference between UTC time and the shopper\'s browser local time, in minutes.
|
||||
*/
|
||||
'timeZoneOffset': number;
|
||||
/**
|
||||
* The user agent value of the shopper\'s browser.
|
||||
*/
|
||||
'userAgent': string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "acceptHeader",
|
||||
"baseName": "acceptHeader",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "colorDepth",
|
||||
"baseName": "colorDepth",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "javaEnabled",
|
||||
"baseName": "javaEnabled",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "javaScriptEnabled",
|
||||
"baseName": "javaScriptEnabled",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "language",
|
||||
"baseName": "language",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "screenHeight",
|
||||
"baseName": "screenHeight",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "screenWidth",
|
||||
"baseName": "screenWidth",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "timeZoneOffset",
|
||||
"baseName": "timeZoneOffset",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "userAgent",
|
||||
"baseName": "userAgent",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return BrowserInfo.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,96 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Card {
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'cvc'?: string;
|
||||
/**
|
||||
* The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November
|
||||
*/
|
||||
'expiryMonth': string;
|
||||
/**
|
||||
* The card expiry year. Format: 4 digits. For example: 2020
|
||||
*/
|
||||
'expiryYear': string;
|
||||
/**
|
||||
* The name of the cardholder, as printed on the card.
|
||||
*/
|
||||
'holderName': string;
|
||||
/**
|
||||
* The issue number of the card (for some UK debit cards only).
|
||||
*/
|
||||
'issueNumber'?: string;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'number': string;
|
||||
/**
|
||||
* The month component of the start date (for some UK debit cards only).
|
||||
*/
|
||||
'startMonth'?: string;
|
||||
/**
|
||||
* The year component of the start date (for some UK debit cards only).
|
||||
*/
|
||||
'startYear'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "cvc",
|
||||
"baseName": "cvc",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "expiryMonth",
|
||||
"baseName": "expiryMonth",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "expiryYear",
|
||||
"baseName": "expiryYear",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "holderName",
|
||||
"baseName": "holderName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "issueNumber",
|
||||
"baseName": "issueNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "number",
|
||||
"baseName": "number",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "startMonth",
|
||||
"baseName": "startMonth",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "startYear",
|
||||
"baseName": "startYear",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Card.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,225 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Amount } from './amount';
|
||||
|
||||
export class CheckoutPaymentsAction {
|
||||
/**
|
||||
* The voucher alternative reference code.
|
||||
*/
|
||||
'alternativeReference'?: string;
|
||||
/**
|
||||
* When the redirect URL must be accessed via POST, use this data to post to the redirect URL.
|
||||
*/
|
||||
'data'?: object;
|
||||
/**
|
||||
* The URL to download the voucher.
|
||||
*/
|
||||
'downloadUrl'?: string;
|
||||
/**
|
||||
* The date time of the voucher expiry.
|
||||
*/
|
||||
'expiresAt'?: string;
|
||||
'initialAmount'?: Amount;
|
||||
/**
|
||||
* The URL to the detailed instructions to make payment using the voucher.
|
||||
*/
|
||||
'instructionsUrl'?: string;
|
||||
/**
|
||||
* The issuer of the voucher.
|
||||
*/
|
||||
'issuer'?: string;
|
||||
/**
|
||||
* The shopper telephone number (partially masked).
|
||||
*/
|
||||
'maskedTelephoneNumber'?: string;
|
||||
/**
|
||||
* The merchant name.
|
||||
*/
|
||||
'merchantName'?: string;
|
||||
/**
|
||||
* The merchant reference.
|
||||
*/
|
||||
'merchantReference'?: string;
|
||||
/**
|
||||
* Specifies the HTTP method, for example GET or POST.
|
||||
*/
|
||||
'method'?: string;
|
||||
/**
|
||||
* When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling.
|
||||
*/
|
||||
'paymentData'?: string;
|
||||
/**
|
||||
* Specifies the payment method.
|
||||
*/
|
||||
'paymentMethodType'?: string;
|
||||
/**
|
||||
* The contents of the QR code as a UTF8 string.
|
||||
*/
|
||||
'qrCodeData'?: string;
|
||||
/**
|
||||
* The voucher reference code.
|
||||
*/
|
||||
'reference'?: string;
|
||||
/**
|
||||
* The shopper email.
|
||||
*/
|
||||
'shopperEmail'?: string;
|
||||
/**
|
||||
* The shopper name.
|
||||
*/
|
||||
'shopperName'?: string;
|
||||
'surcharge'?: Amount;
|
||||
/**
|
||||
* A token to pass to the 3DS2 Component to get the fingerprint/challenge.
|
||||
*/
|
||||
'token'?: string;
|
||||
'totalAmount'?: Amount;
|
||||
/**
|
||||
* Enum that specifies the action that needs to be taken by the client.
|
||||
*/
|
||||
'type'?: CheckoutPaymentsAction.TypeEnum;
|
||||
/**
|
||||
* Specifies the URL to redirect to.
|
||||
*/
|
||||
'url'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "alternativeReference",
|
||||
"baseName": "alternativeReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "data",
|
||||
"baseName": "data",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "downloadUrl",
|
||||
"baseName": "downloadUrl",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "expiresAt",
|
||||
"baseName": "expiresAt",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "initialAmount",
|
||||
"baseName": "initialAmount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "instructionsUrl",
|
||||
"baseName": "instructionsUrl",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "issuer",
|
||||
"baseName": "issuer",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "maskedTelephoneNumber",
|
||||
"baseName": "maskedTelephoneNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantName",
|
||||
"baseName": "merchantName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantReference",
|
||||
"baseName": "merchantReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "method",
|
||||
"baseName": "method",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "paymentData",
|
||||
"baseName": "paymentData",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "paymentMethodType",
|
||||
"baseName": "paymentMethodType",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "qrCodeData",
|
||||
"baseName": "qrCodeData",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "reference",
|
||||
"baseName": "reference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperEmail",
|
||||
"baseName": "shopperEmail",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperName",
|
||||
"baseName": "shopperName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "surcharge",
|
||||
"baseName": "surcharge",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "token",
|
||||
"baseName": "token",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "totalAmount",
|
||||
"baseName": "totalAmount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"baseName": "type",
|
||||
"type": "CheckoutPaymentsAction.TypeEnum"
|
||||
},
|
||||
{
|
||||
"name": "url",
|
||||
"baseName": "url",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return CheckoutPaymentsAction.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace CheckoutPaymentsAction {
|
||||
export enum TypeEnum {
|
||||
Await = <any> 'await',
|
||||
QrCode = <any> 'qrCode',
|
||||
Redirect = <any> 'redirect',
|
||||
ThreeDS2Challenge = <any> 'threeDS2Challenge',
|
||||
ThreeDS2Fingerprint = <any> 'threeDS2Fingerprint',
|
||||
Voucher = <any> 'voucher',
|
||||
WechatpaySDK = <any> 'wechatpaySDK'
|
||||
}
|
||||
}
|
||||
@@ -1,42 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class CommonField {
|
||||
/**
|
||||
* Name of the field. For example, Name of External Platform.
|
||||
*/
|
||||
'name'?: string;
|
||||
/**
|
||||
* Version of the field. For example, Version of External Platform.
|
||||
*/
|
||||
'version'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "name",
|
||||
"baseName": "name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "version",
|
||||
"baseName": "version",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return CommonField.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,78 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Company {
|
||||
/**
|
||||
* The company website\'s home page.
|
||||
*/
|
||||
'homepage'?: string;
|
||||
/**
|
||||
* The company name.
|
||||
*/
|
||||
'name'?: string;
|
||||
/**
|
||||
* Registration number of the company.
|
||||
*/
|
||||
'registrationNumber'?: string;
|
||||
/**
|
||||
* Registry location of the company.
|
||||
*/
|
||||
'registryLocation'?: string;
|
||||
/**
|
||||
* Tax ID of the company.
|
||||
*/
|
||||
'taxId'?: string;
|
||||
/**
|
||||
* The company type.
|
||||
*/
|
||||
'type'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "homepage",
|
||||
"baseName": "homepage",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"baseName": "name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "registrationNumber",
|
||||
"baseName": "registrationNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "registryLocation",
|
||||
"baseName": "registryLocation",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "taxId",
|
||||
"baseName": "taxId",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"baseName": "type",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Company.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,61 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Avs } from './avs';
|
||||
import { Installments } from './installments';
|
||||
import { ShopperInput } from './shopperInput';
|
||||
|
||||
export class Configuration {
|
||||
'avs'?: Avs;
|
||||
/**
|
||||
* Determines whether the cardholder name should be provided or not. Permitted values: * NONE * OPTIONAL * REQUIRED
|
||||
*/
|
||||
'cardHolderName'?: Configuration.CardHolderNameEnum;
|
||||
'installments'?: Installments;
|
||||
'shopperInput'?: ShopperInput;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "avs",
|
||||
"baseName": "avs",
|
||||
"type": "Avs"
|
||||
},
|
||||
{
|
||||
"name": "cardHolderName",
|
||||
"baseName": "cardHolderName",
|
||||
"type": "Configuration.CardHolderNameEnum"
|
||||
},
|
||||
{
|
||||
"name": "installments",
|
||||
"baseName": "installments",
|
||||
"type": "Installments"
|
||||
},
|
||||
{
|
||||
"name": "shopperInput",
|
||||
"baseName": "shopperInput",
|
||||
"type": "ShopperInput"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Configuration.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace Configuration {
|
||||
export enum CardHolderNameEnum {
|
||||
NONE = <any> 'NONE',
|
||||
OPTIONAL = <any> 'OPTIONAL',
|
||||
REQUIRED = <any> 'REQUIRED'
|
||||
}
|
||||
}
|
||||
@@ -1,152 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Address } from './address';
|
||||
import { Amount } from './amount';
|
||||
|
||||
export class CreatePaymentLinkRequest {
|
||||
/**
|
||||
* List of payments methods to be presented to the shopper. To refer to payment methods, use their `brandCode` from [Payment methods overview](https://docs.adyen.com/payment-methods).
|
||||
*/
|
||||
'allowedPaymentMethods'?: Array<string>;
|
||||
'amount': Amount;
|
||||
'billingAddress'?: Address;
|
||||
/**
|
||||
* List of payments methods to be hidden from the shopper. To refer to payment methods, use their `brandCode` from [Payment methods overview](https://docs.adyen.com/payment-methods).
|
||||
*/
|
||||
'blockedPaymentMethods'?: Array<string>;
|
||||
/**
|
||||
* The shopper\'s country code.
|
||||
*/
|
||||
'countryCode'?: string;
|
||||
'deliveryAddress'?: Address;
|
||||
/**
|
||||
* A short description visible on the Pay By Link page. Maximum length: 280 characters.
|
||||
*/
|
||||
'description'?: string;
|
||||
/**
|
||||
* The date that the Pay By Link expires; e.g. 2019-03-23T12:25:28Z. If not provided, the default expiry duration is 1 day.
|
||||
*/
|
||||
'expiresAt'?: string;
|
||||
/**
|
||||
* The merchant account identifier, with which you want to process the transaction.
|
||||
*/
|
||||
'merchantAccount': string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Merchant URL used for redirection after payment is completed
|
||||
*/
|
||||
'returnUrl'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The combination of a language code and a country code to specify the language to be used in the payment.
|
||||
*/
|
||||
'shopperLocale'?: string;
|
||||
/**
|
||||
* The shopper\'s reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments.
|
||||
*/
|
||||
'shopperReference'?: string;
|
||||
/**
|
||||
* When true and `shopperReference` is provided, the payment details will be stored.
|
||||
*/
|
||||
'storePaymentMethod'?: boolean;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "allowedPaymentMethods",
|
||||
"baseName": "allowedPaymentMethods",
|
||||
"type": "Array<string>"
|
||||
},
|
||||
{
|
||||
"name": "amount",
|
||||
"baseName": "amount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "billingAddress",
|
||||
"baseName": "billingAddress",
|
||||
"type": "Address"
|
||||
},
|
||||
{
|
||||
"name": "blockedPaymentMethods",
|
||||
"baseName": "blockedPaymentMethods",
|
||||
"type": "Array<string>"
|
||||
},
|
||||
{
|
||||
"name": "countryCode",
|
||||
"baseName": "countryCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "deliveryAddress",
|
||||
"baseName": "deliveryAddress",
|
||||
"type": "Address"
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"baseName": "description",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "expiresAt",
|
||||
"baseName": "expiresAt",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantAccount",
|
||||
"baseName": "merchantAccount",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "reference",
|
||||
"baseName": "reference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "returnUrl",
|
||||
"baseName": "returnUrl",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperEmail",
|
||||
"baseName": "shopperEmail",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperLocale",
|
||||
"baseName": "shopperLocale",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperReference",
|
||||
"baseName": "shopperReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "storePaymentMethod",
|
||||
"baseName": "storePaymentMethod",
|
||||
"type": "boolean"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return CreatePaymentLinkRequest.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,58 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Amount } from './amount';
|
||||
|
||||
export class CreatePaymentLinkResponse {
|
||||
'amount'?: Amount;
|
||||
/**
|
||||
* The date that the Pay By Link expires; e.g. 2019-03-23T12:25:28Z.
|
||||
*/
|
||||
'expiresAt': string;
|
||||
/**
|
||||
* The reference that was specified when the Pay By Link URL was created.
|
||||
*/
|
||||
'reference': string;
|
||||
/**
|
||||
* The URL at which the shopper can complete the payment.
|
||||
*/
|
||||
'url': string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "amount",
|
||||
"baseName": "amount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "expiresAt",
|
||||
"baseName": "expiresAt",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "reference",
|
||||
"baseName": "reference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "url",
|
||||
"baseName": "url",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return CreatePaymentLinkResponse.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class DetailsRequest {
|
||||
/**
|
||||
* Use this collection to submit the details that were returned as a result of the `/payments` call.
|
||||
*/
|
||||
'details': object;
|
||||
/**
|
||||
* The `paymentData` value that you received in the response to the `/payments` call.
|
||||
*/
|
||||
'paymentData'?: string;
|
||||
/**
|
||||
* Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.
|
||||
*/
|
||||
'threeDSAuthenticationOnly'?: boolean;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "details",
|
||||
"baseName": "details",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "paymentData",
|
||||
"baseName": "paymentData",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "threeDSAuthenticationOnly",
|
||||
"baseName": "threeDSAuthenticationOnly",
|
||||
"type": "boolean"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return DetailsRequest.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,56 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class DeviceRenderOptions {
|
||||
/**
|
||||
* Supported SDK interface types. Allowed values: * Native * Html * both
|
||||
*/
|
||||
'sdkInterface'?: DeviceRenderOptions.SdkInterfaceEnum;
|
||||
/**
|
||||
* UI types supported for displaying specific challenges. Allowed values: * text * singleSelect * outOfBand * otherHtml * multiSelect
|
||||
*/
|
||||
'sdkUiType'?: Array<DeviceRenderOptions.SdkUiTypeEnum>;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "sdkInterface",
|
||||
"baseName": "sdkInterface",
|
||||
"type": "DeviceRenderOptions.SdkInterfaceEnum"
|
||||
},
|
||||
{
|
||||
"name": "sdkUiType",
|
||||
"baseName": "sdkUiType",
|
||||
"type": "Array<DeviceRenderOptions.SdkUiTypeEnum>"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return DeviceRenderOptions.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace DeviceRenderOptions {
|
||||
export enum SdkInterfaceEnum {
|
||||
Html = <any> 'Html',
|
||||
Native = <any> 'Native',
|
||||
Both = <any> 'both'
|
||||
}
|
||||
export enum SdkUiTypeEnum {
|
||||
MultiSelect = <any> 'multiSelect',
|
||||
OtherHtml = <any> 'otherHtml',
|
||||
OutOfBand = <any> 'outOfBand',
|
||||
SingleSelect = <any> 'singleSelect',
|
||||
Text = <any> 'text'
|
||||
}
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class ExternalPlatform {
|
||||
/**
|
||||
* External platform integrator.
|
||||
*/
|
||||
'integrator'?: string;
|
||||
/**
|
||||
* Name of the field. For example, Name of External Platform.
|
||||
*/
|
||||
'name'?: string;
|
||||
/**
|
||||
* Version of the field. For example, Version of External Platform.
|
||||
*/
|
||||
'version'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "integrator",
|
||||
"baseName": "integrator",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"baseName": "name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "version",
|
||||
"baseName": "version",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return ExternalPlatform.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,121 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Amount } from './amount';
|
||||
|
||||
export class ForexQuote {
|
||||
/**
|
||||
* The account name.
|
||||
*/
|
||||
'account'?: string;
|
||||
/**
|
||||
* The account type.
|
||||
*/
|
||||
'accountType'?: string;
|
||||
'baseAmount'?: Amount;
|
||||
/**
|
||||
* The base points.
|
||||
*/
|
||||
'basePoints': number;
|
||||
'buy'?: Amount;
|
||||
'interbank'?: Amount;
|
||||
/**
|
||||
* The reference assigned to the forex quote request.
|
||||
*/
|
||||
'reference'?: string;
|
||||
'sell'?: Amount;
|
||||
/**
|
||||
* The signature to validate the integrity.
|
||||
*/
|
||||
'signature'?: string;
|
||||
/**
|
||||
* The source of the forex quote.
|
||||
*/
|
||||
'source'?: string;
|
||||
/**
|
||||
* The type of forex.
|
||||
*/
|
||||
'type'?: string;
|
||||
/**
|
||||
* The date until which the forex quote is valid.
|
||||
*/
|
||||
'validTill': Date;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "account",
|
||||
"baseName": "account",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "accountType",
|
||||
"baseName": "accountType",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "baseAmount",
|
||||
"baseName": "baseAmount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "basePoints",
|
||||
"baseName": "basePoints",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "buy",
|
||||
"baseName": "buy",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "interbank",
|
||||
"baseName": "interbank",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "reference",
|
||||
"baseName": "reference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "sell",
|
||||
"baseName": "sell",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "signature",
|
||||
"baseName": "signature",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "source",
|
||||
"baseName": "source",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"baseName": "type",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "validTill",
|
||||
"baseName": "validTill",
|
||||
"type": "Date"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return ForexQuote.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class FraudCheckResult {
|
||||
/**
|
||||
* The fraud score generated by the risk check.
|
||||
*/
|
||||
'accountScore': number;
|
||||
/**
|
||||
* The ID of the risk check.
|
||||
*/
|
||||
'checkId': number;
|
||||
/**
|
||||
* The name of the risk check.
|
||||
*/
|
||||
'name': string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "accountScore",
|
||||
"baseName": "accountScore",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "checkId",
|
||||
"baseName": "checkId",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"baseName": "name",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return FraudCheckResult.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { FraudCheckResult } from './fraudCheckResult';
|
||||
|
||||
export class FraudResult {
|
||||
/**
|
||||
* The total fraud score generated by the risk checks.
|
||||
*/
|
||||
'accountScore': number;
|
||||
/**
|
||||
* The result of the individual risk checks.
|
||||
*/
|
||||
'results'?: Array<FraudCheckResult>;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "accountScore",
|
||||
"baseName": "accountScore",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "results",
|
||||
"baseName": "results",
|
||||
"type": "Array<FraudCheckResult>"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return FraudResult.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
|
||||
|
||||
export * from './accountInfo';
|
||||
export * from './address';
|
||||
export * from './amount';
|
||||
export * from './avs';
|
||||
export * from './bankAccount';
|
||||
export * from './browserInfo';
|
||||
export * from './card';
|
||||
export * from './company';
|
||||
export * from './configuration';
|
||||
export * from './detailsRequest';
|
||||
export * from './deviceRenderOptions';
|
||||
export * from './forexQuote';
|
||||
export * from './fraudCheckResult';
|
||||
export * from './fraudResult';
|
||||
export * from './inputDetail';
|
||||
export * from './installments';
|
||||
export * from './item';
|
||||
export * from './lineItem';
|
||||
export * from './merchantRiskIndicator';
|
||||
export * from './name';
|
||||
export * from './paymentMethod';
|
||||
export * from './paymentMethodGroup';
|
||||
export * from './paymentMethodsGroup';
|
||||
export * from './paymentMethodsRequest';
|
||||
export * from './paymentMethodsResponse';
|
||||
export * from './paymentRequest';
|
||||
export * from './paymentResponse';
|
||||
export * from './paymentSetupRequest';
|
||||
export * from './paymentSetupResponse';
|
||||
export * from './paymentVerificationRequest';
|
||||
export * from './paymentVerificationResponse';
|
||||
export * from './recurring';
|
||||
export * from './recurringDetail';
|
||||
export * from './redirect';
|
||||
export * from './sDKEphemPubKey';
|
||||
export * from './serviceError';
|
||||
export * from './shopperInput';
|
||||
export * from './split';
|
||||
export * from './splitAmount';
|
||||
export * from './storedDetails';
|
||||
export * from './subInputDetail';
|
||||
export * from './threeDS2RequestData';
|
||||
export * from './threeDSecureData';
|
||||
@@ -1,107 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Item } from './item';
|
||||
import { SubInputDetail } from './subInputDetail';
|
||||
|
||||
export class InputDetail {
|
||||
/**
|
||||
* Configuration parameters for the required input.
|
||||
*/
|
||||
'configuration'?: object;
|
||||
/**
|
||||
* Input details can also be provided recursively.
|
||||
*/
|
||||
'details'?: Array<SubInputDetail>;
|
||||
/**
|
||||
* Input details can also be provided recursively (deprecated).
|
||||
*/
|
||||
'inputDetails'?: Array<SubInputDetail>;
|
||||
/**
|
||||
* In case of a select, the URL from which to query the items.
|
||||
*/
|
||||
'itemSearchUrl'?: string;
|
||||
/**
|
||||
* In case of a select, the items to choose from.
|
||||
*/
|
||||
'items'?: Array<Item>;
|
||||
/**
|
||||
* The value to provide in the result.
|
||||
*/
|
||||
'key'?: string;
|
||||
/**
|
||||
* True if this input value is optional.
|
||||
*/
|
||||
'optional'?: boolean;
|
||||
/**
|
||||
* The type of the required input.
|
||||
*/
|
||||
'type'?: string;
|
||||
/**
|
||||
* The value can be pre-filled, if available.
|
||||
*/
|
||||
'value'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "configuration",
|
||||
"baseName": "configuration",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "details",
|
||||
"baseName": "details",
|
||||
"type": "Array<SubInputDetail>"
|
||||
},
|
||||
{
|
||||
"name": "inputDetails",
|
||||
"baseName": "inputDetails",
|
||||
"type": "Array<SubInputDetail>"
|
||||
},
|
||||
{
|
||||
"name": "itemSearchUrl",
|
||||
"baseName": "itemSearchUrl",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"baseName": "items",
|
||||
"type": "Array<Item>"
|
||||
},
|
||||
{
|
||||
"name": "key",
|
||||
"baseName": "key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "optional",
|
||||
"baseName": "optional",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"baseName": "type",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"baseName": "value",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return InputDetail.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Installments {
|
||||
/**
|
||||
* 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': number;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "value",
|
||||
"baseName": "value",
|
||||
"type": "number"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Installments.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Item {
|
||||
/**
|
||||
* The value to provide in the result.
|
||||
*/
|
||||
'id'?: string;
|
||||
/**
|
||||
* The display name.
|
||||
*/
|
||||
'name'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "id",
|
||||
"baseName": "id",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"baseName": "name",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Item.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,104 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class LineItem {
|
||||
/**
|
||||
* Item amount excluding the tax, in minor units.
|
||||
*/
|
||||
'amountExcludingTax'?: number;
|
||||
/**
|
||||
* Item amount including the tax, in minor units.
|
||||
*/
|
||||
'amountIncludingTax'?: number;
|
||||
/**
|
||||
* Description of the line item.
|
||||
*/
|
||||
'description'?: string;
|
||||
/**
|
||||
* ID of the line item.
|
||||
*/
|
||||
'id'?: string;
|
||||
/**
|
||||
* Number of items.
|
||||
*/
|
||||
'quantity'?: number;
|
||||
/**
|
||||
* Tax amount, in minor units.
|
||||
*/
|
||||
'taxAmount'?: number;
|
||||
/**
|
||||
* Tax category: High, Low, None, Zero
|
||||
*/
|
||||
'taxCategory'?: LineItem.TaxCategoryEnum;
|
||||
/**
|
||||
* Tax percentage, in minor units.
|
||||
*/
|
||||
'taxPercentage'?: number;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "amountExcludingTax",
|
||||
"baseName": "amountExcludingTax",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "amountIncludingTax",
|
||||
"baseName": "amountIncludingTax",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"baseName": "description",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"baseName": "id",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "quantity",
|
||||
"baseName": "quantity",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "taxAmount",
|
||||
"baseName": "taxAmount",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "taxCategory",
|
||||
"baseName": "taxCategory",
|
||||
"type": "LineItem.TaxCategoryEnum"
|
||||
},
|
||||
{
|
||||
"name": "taxPercentage",
|
||||
"baseName": "taxPercentage",
|
||||
"type": "number"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return LineItem.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace LineItem {
|
||||
export enum TaxCategoryEnum {
|
||||
High = <any> 'High',
|
||||
Low = <any> 'Low',
|
||||
None = <any> 'None',
|
||||
Zero = <any> 'Zero'
|
||||
}
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class MerchantDevice {
|
||||
/**
|
||||
* Operating system running on the merchant device.
|
||||
*/
|
||||
'os'?: string;
|
||||
/**
|
||||
* Version of the operating system on the merchant device.
|
||||
*/
|
||||
'osVersion'?: string;
|
||||
/**
|
||||
* Merchant device reference.
|
||||
*/
|
||||
'reference'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "os",
|
||||
"baseName": "os",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "osVersion",
|
||||
"baseName": "osVersion",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "reference",
|
||||
"baseName": "reference",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return MerchantDevice.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,120 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Amount } from './amount';
|
||||
|
||||
export class MerchantRiskIndicator {
|
||||
/**
|
||||
* Whether the chosen delivery address is identical to the billing address.
|
||||
*/
|
||||
'addressMatch'?: boolean;
|
||||
/**
|
||||
* Indicator regarding the delivery address. Allowed values: * `shipToBillingAddress` * `shipToVerifiedAddress` * `shipToNewAddress` * `shipToStore` * `digitalGoods` * `goodsNotShipped` * `other`
|
||||
*/
|
||||
'deliveryAddressIndicator'?: MerchantRiskIndicator.DeliveryAddressIndicatorEnum;
|
||||
/**
|
||||
* The delivery email address (for digital goods).
|
||||
*/
|
||||
'deliveryEmail'?: string;
|
||||
/**
|
||||
* The estimated delivery time for the shopper to receive the goods. Allowed values: * `electronicDelivery` * `sameDayShipping` * `overnightShipping` * `twoOrMoreDaysShipping`
|
||||
*/
|
||||
'deliveryTimeframe'?: MerchantRiskIndicator.DeliveryTimeframeEnum;
|
||||
'giftCardAmount'?: Amount;
|
||||
/**
|
||||
* Number of individual prepaid or gift cards used for this purchase.
|
||||
*/
|
||||
'giftCardCount'?: number;
|
||||
/**
|
||||
* For pre-order purchases, the expected date this product will be available to the shopper.
|
||||
*/
|
||||
'preOrderDate'?: Date;
|
||||
/**
|
||||
* Indicator for whether this transaction is for pre-ordering a product.
|
||||
*/
|
||||
'preOrderPurchase'?: boolean;
|
||||
/**
|
||||
* Indicator for whether the shopper has already purchased the same items in the past.
|
||||
*/
|
||||
'reorderItems'?: boolean;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "addressMatch",
|
||||
"baseName": "addressMatch",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "deliveryAddressIndicator",
|
||||
"baseName": "deliveryAddressIndicator",
|
||||
"type": "MerchantRiskIndicator.DeliveryAddressIndicatorEnum"
|
||||
},
|
||||
{
|
||||
"name": "deliveryEmail",
|
||||
"baseName": "deliveryEmail",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "deliveryTimeframe",
|
||||
"baseName": "deliveryTimeframe",
|
||||
"type": "MerchantRiskIndicator.DeliveryTimeframeEnum"
|
||||
},
|
||||
{
|
||||
"name": "giftCardAmount",
|
||||
"baseName": "giftCardAmount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "giftCardCount",
|
||||
"baseName": "giftCardCount",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "preOrderDate",
|
||||
"baseName": "preOrderDate",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "preOrderPurchase",
|
||||
"baseName": "preOrderPurchase",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "reorderItems",
|
||||
"baseName": "reorderItems",
|
||||
"type": "boolean"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return MerchantRiskIndicator.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace MerchantRiskIndicator {
|
||||
export enum DeliveryAddressIndicatorEnum {
|
||||
ShipToBillingAddress = <any> 'shipToBillingAddress',
|
||||
ShipToVerifiedAddress = <any> 'shipToVerifiedAddress',
|
||||
ShipToNewAddress = <any> 'shipToNewAddress',
|
||||
ShipToStore = <any> 'shipToStore',
|
||||
DigitalGoods = <any> 'digitalGoods',
|
||||
GoodsNotShipped = <any> 'goodsNotShipped',
|
||||
Other = <any> 'other'
|
||||
}
|
||||
export enum DeliveryTimeframeEnum {
|
||||
ElectronicDelivery = <any> 'electronicDelivery',
|
||||
SameDayShipping = <any> 'sameDayShipping',
|
||||
OvernightShipping = <any> 'overnightShipping',
|
||||
TwoOrMoreDaysShipping = <any> 'twoOrMoreDaysShipping'
|
||||
}
|
||||
}
|
||||
@@ -1,67 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Name {
|
||||
/**
|
||||
* The first name.
|
||||
*/
|
||||
'firstName': string;
|
||||
/**
|
||||
* The gender. >The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`.
|
||||
*/
|
||||
'gender': Name.GenderEnum;
|
||||
/**
|
||||
* The name\'s infix, if applicable. >A maximum length of twenty (20) characters is imposed.
|
||||
*/
|
||||
'infix'?: string;
|
||||
/**
|
||||
* The last name.
|
||||
*/
|
||||
'lastName': string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "firstName",
|
||||
"baseName": "firstName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "gender",
|
||||
"baseName": "gender",
|
||||
"type": "Name.GenderEnum"
|
||||
},
|
||||
{
|
||||
"name": "infix",
|
||||
"baseName": "infix",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "lastName",
|
||||
"baseName": "lastName",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Name.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace Name {
|
||||
export enum GenderEnum {
|
||||
MALE = <any> 'MALE',
|
||||
FEMALE = <any> 'FEMALE',
|
||||
UNKNOWN = <any> 'UNKNOWN'
|
||||
}
|
||||
}
|
||||
@@ -1,104 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { InputDetail } from './inputDetail';
|
||||
import { PaymentMethodGroup } from './paymentMethodGroup';
|
||||
|
||||
export class PaymentMethod {
|
||||
/**
|
||||
* List of possible brands. For example: visa, mc.
|
||||
*/
|
||||
'brands'?: Array<string>;
|
||||
/**
|
||||
* The configuration of the payment method.
|
||||
*/
|
||||
'configuration'?: object;
|
||||
/**
|
||||
* All input details to be provided to complete the payment with this payment method.
|
||||
*/
|
||||
'details'?: Array<InputDetail>;
|
||||
'group'?: PaymentMethodGroup;
|
||||
/**
|
||||
* All input details to be provided to complete the payment with this payment method.
|
||||
*/
|
||||
'inputDetails'?: Array<InputDetail>;
|
||||
/**
|
||||
* The displayable name of this payment method.
|
||||
*/
|
||||
'name'?: string;
|
||||
/**
|
||||
* Echo data required to send in next calls.
|
||||
*/
|
||||
'paymentMethodData'?: string;
|
||||
/**
|
||||
* Indicates whether this payment method supports tokenization or not.
|
||||
*/
|
||||
'supportsRecurring'?: boolean;
|
||||
/**
|
||||
* The unique payment method code.
|
||||
*/
|
||||
'type'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "brands",
|
||||
"baseName": "brands",
|
||||
"type": "Array<string>"
|
||||
},
|
||||
{
|
||||
"name": "configuration",
|
||||
"baseName": "configuration",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "details",
|
||||
"baseName": "details",
|
||||
"type": "Array<InputDetail>"
|
||||
},
|
||||
{
|
||||
"name": "group",
|
||||
"baseName": "group",
|
||||
"type": "PaymentMethodGroup"
|
||||
},
|
||||
{
|
||||
"name": "inputDetails",
|
||||
"baseName": "inputDetails",
|
||||
"type": "Array<InputDetail>"
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"baseName": "name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "paymentMethodData",
|
||||
"baseName": "paymentMethodData",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "supportsRecurring",
|
||||
"baseName": "supportsRecurring",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"baseName": "type",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentMethod.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class PaymentMethodGroup {
|
||||
/**
|
||||
* The name of the group.
|
||||
*/
|
||||
'name'?: string;
|
||||
/**
|
||||
* Echo data to be used if the payment method is displayed as part of this group.
|
||||
*/
|
||||
'paymentMethodData'?: string;
|
||||
/**
|
||||
* The unique code of the group.
|
||||
*/
|
||||
'type'?: string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "name",
|
||||
"baseName": "name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "paymentMethodData",
|
||||
"baseName": "paymentMethodData",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"baseName": "type",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentMethodGroup.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class PaymentMethodsGroup {
|
||||
/**
|
||||
* The type to submit for any payment method in this group.
|
||||
*/
|
||||
'groupType'?: string;
|
||||
/**
|
||||
* The human-readable name of this group.
|
||||
*/
|
||||
'name'?: string;
|
||||
/**
|
||||
* The types of payment methods that belong in this group.
|
||||
*/
|
||||
'types'?: Array<string>;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "groupType",
|
||||
"baseName": "groupType",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"baseName": "name",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "types",
|
||||
"baseName": "types",
|
||||
"type": "Array<string>"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentMethodsGroup.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,141 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Amount } from './amount';
|
||||
import {AdditionalData3DSecure} from "../payments/additionalData3DSecure";
|
||||
import {AdditionalDataAirline} from "../payments/additionalDataAirline";
|
||||
import {AdditionalDataCommon} from "../payments/additionalDataCommon";
|
||||
import {AdditionalDataLevel23} from "../payments/additionalDataLevel23";
|
||||
import {AdditionalDataLodging} from "../payments/additionalDataLodging";
|
||||
import {AdditionalDataOpenInvoice} from "../payments/additionalDataOpenInvoice";
|
||||
import {AdditionalDataRatepay} from "../payments/additionalDataRatepay";
|
||||
import {AdditionalDataRetry} from "../payments/additionalDataRetry";
|
||||
import {AdditionalDataRisk} from "../payments/additionalDataRisk";
|
||||
import {AdditionalDataRiskStandalone} from "../payments/additionalDataRiskStandalone";
|
||||
import {AdditionalDataTemporaryServices} from "../payments/additionalDataTemporaryServices";
|
||||
import {AdditionalDataWallets} from "../payments/additionalDataWallets";
|
||||
|
||||
type AdditionalData = AdditionalData3DSecure | AdditionalDataAirline | AdditionalDataCommon | AdditionalDataLevel23 | AdditionalDataLodging | AdditionalDataOpenInvoice | AdditionalDataRatepay | AdditionalDataRetry | AdditionalDataRisk | AdditionalDataRiskStandalone | AdditionalDataTemporaryServices | AdditionalDataWallets;
|
||||
export class PaymentMethodsRequest {
|
||||
/**
|
||||
* 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'?: AdditionalData;
|
||||
/**
|
||||
* List of payments methods to be presented to the shopper. To refer to payment methods, use their `brandCode` from [Payment methods overview](https://docs.adyen.com/payment-methods).
|
||||
*/
|
||||
'allowedPaymentMethods'?: Array<string>;
|
||||
'amount'?: Amount;
|
||||
/**
|
||||
* List of payments methods to be hidden from the shopper. To refer to payment methods, use their `brandCode` from [Payment methods overview](https://docs.adyen.com/payment-methods).
|
||||
*/
|
||||
'blockedPaymentMethods'?: Array<string>;
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
'channel'?: PaymentMethodsRequest.ChannelEnum;
|
||||
/**
|
||||
* The shopper\'s country code.
|
||||
*/
|
||||
'countryCode'?: string;
|
||||
/**
|
||||
* Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.
|
||||
*/
|
||||
'enableRealTimeUpdate'?: boolean;
|
||||
/**
|
||||
* The merchant account identifier, with which you want to process the transaction.
|
||||
*/
|
||||
'merchantAccount': string;
|
||||
/**
|
||||
* The combination of a language code and a country code to specify the language to be used in the payment.
|
||||
*/
|
||||
'shopperLocale'?: string;
|
||||
/**
|
||||
* The shopper\'s reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments.
|
||||
*/
|
||||
'shopperReference'?: string;
|
||||
/**
|
||||
* If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/native-3ds2/authentication-only), and not the payment authorisation.
|
||||
*/
|
||||
'threeDSAuthenticationOnly'?: boolean;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "additionalData",
|
||||
"baseName": "additionalData",
|
||||
"type": "AdditionalData"
|
||||
},
|
||||
{
|
||||
"name": "allowedPaymentMethods",
|
||||
"baseName": "allowedPaymentMethods",
|
||||
"type": "Array<string>"
|
||||
},
|
||||
{
|
||||
"name": "amount",
|
||||
"baseName": "amount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "blockedPaymentMethods",
|
||||
"baseName": "blockedPaymentMethods",
|
||||
"type": "Array<string>"
|
||||
},
|
||||
{
|
||||
"name": "channel",
|
||||
"baseName": "channel",
|
||||
"type": "PaymentMethodsRequest.ChannelEnum"
|
||||
},
|
||||
{
|
||||
"name": "countryCode",
|
||||
"baseName": "countryCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enableRealTimeUpdate",
|
||||
"baseName": "enableRealTimeUpdate",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "merchantAccount",
|
||||
"baseName": "merchantAccount",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperLocale",
|
||||
"baseName": "shopperLocale",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperReference",
|
||||
"baseName": "shopperReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "threeDSAuthenticationOnly",
|
||||
"baseName": "threeDSAuthenticationOnly",
|
||||
"type": "boolean"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentMethodsRequest.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace PaymentMethodsRequest {
|
||||
export enum ChannelEnum {
|
||||
IOS = <any> 'iOS',
|
||||
Android = <any> 'Android',
|
||||
Web = <any> 'Web'
|
||||
}
|
||||
}
|
||||
@@ -1,64 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { PaymentMethod } from './paymentMethod';
|
||||
import { PaymentMethodsGroup } from './paymentMethodsGroup';
|
||||
import { RecurringDetail } from './recurringDetail';
|
||||
import { StoredPaymentMethod } from './storedPaymentMethod';
|
||||
|
||||
export class PaymentMethodsResponse {
|
||||
/**
|
||||
* Groups of payment methods.
|
||||
*/
|
||||
'groups'?: Array<PaymentMethodsGroup>;
|
||||
/**
|
||||
* Detailed list of one-click payment methods.
|
||||
*/
|
||||
'oneClickPaymentMethods'?: Array<RecurringDetail>;
|
||||
/**
|
||||
* Detailed list of payment methods required to generate payment forms.
|
||||
*/
|
||||
'paymentMethods'?: Array<PaymentMethod>;
|
||||
/**
|
||||
* List of all stored payment methods.
|
||||
*/
|
||||
'storedPaymentMethods'?: Array<StoredPaymentMethod>;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "groups",
|
||||
"baseName": "groups",
|
||||
"type": "Array<PaymentMethodsGroup>"
|
||||
},
|
||||
{
|
||||
"name": "oneClickPaymentMethods",
|
||||
"baseName": "oneClickPaymentMethods",
|
||||
"type": "Array<RecurringDetail>"
|
||||
},
|
||||
{
|
||||
"name": "paymentMethods",
|
||||
"baseName": "paymentMethods",
|
||||
"type": "Array<PaymentMethod>"
|
||||
},
|
||||
{
|
||||
"name": "storedPaymentMethods",
|
||||
"baseName": "storedPaymentMethods",
|
||||
"type": "Array<StoredPaymentMethod>"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentMethodsResponse.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,520 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { AccountInfo } from './accountInfo';
|
||||
import { Address } from './address';
|
||||
import { Amount } from './amount';
|
||||
import { ApplicationInfo } from './applicationInfo';
|
||||
import { BrowserInfo } from './browserInfo';
|
||||
import { Company } from './company';
|
||||
import { ForexQuote } from './forexQuote';
|
||||
import { Installments } from './installments';
|
||||
import { LineItem } from './lineItem';
|
||||
import { MerchantRiskIndicator } from './merchantRiskIndicator';
|
||||
import { Name } from './name';
|
||||
import { Split } from './split';
|
||||
import { ThreeDS2RequestData } from './threeDS2RequestData';
|
||||
import { ThreeDSecureData } from './threeDSecureData';
|
||||
import {AdditionalData3DSecure} from "../payments/additionalData3DSecure";
|
||||
import {AdditionalDataAirline} from "../payments/additionalDataAirline";
|
||||
import {AdditionalDataCommon} from "../payments/additionalDataCommon";
|
||||
import {AdditionalDataLevel23} from "../payments/additionalDataLevel23";
|
||||
import {AdditionalDataLodging} from "../payments/additionalDataLodging";
|
||||
import {AdditionalDataOpenInvoice} from "../payments/additionalDataOpenInvoice";
|
||||
import {AdditionalDataRatepay} from "../payments/additionalDataRatepay";
|
||||
import {AdditionalDataRetry} from "../payments/additionalDataRetry";
|
||||
import {AdditionalDataRisk} from "../payments/additionalDataRisk";
|
||||
import {AdditionalDataRiskStandalone} from "../payments/additionalDataRiskStandalone";
|
||||
import {AdditionalDataTemporaryServices} from "../payments/additionalDataTemporaryServices";
|
||||
import {AdditionalDataWallets} from "../payments/additionalDataWallets";
|
||||
|
||||
type AdditionalData = AdditionalData3DSecure | AdditionalDataAirline | AdditionalDataCommon | AdditionalDataLevel23 | AdditionalDataLodging | AdditionalDataOpenInvoice | AdditionalDataRatepay | AdditionalDataRetry | AdditionalDataRisk | AdditionalDataRiskStandalone | AdditionalDataTemporaryServices | AdditionalDataWallets;
|
||||
export class PaymentRequest {
|
||||
'accountInfo'?: AccountInfo;
|
||||
/**
|
||||
* 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'?: AdditionalData;
|
||||
'amount': Amount;
|
||||
'applicationInfo'?: ApplicationInfo;
|
||||
'billingAddress'?: Address;
|
||||
'browserInfo'?: BrowserInfo;
|
||||
/**
|
||||
* The delay between the authorisation and scheduled auto-capture, specified in hours.
|
||||
*/
|
||||
'captureDelayHours'?: number;
|
||||
/**
|
||||
* 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'?: PaymentRequest.ChannelEnum;
|
||||
'company'?: Company;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The shopper\'s date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
|
||||
*/
|
||||
'dateOfBirth'?: Date;
|
||||
'dccQuote'?: ForexQuote;
|
||||
'deliveryAddress'?: Address;
|
||||
/**
|
||||
* 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'?: Date;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
|
||||
*/
|
||||
'enableOneClick'?: boolean;
|
||||
/**
|
||||
* When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
|
||||
*/
|
||||
'enablePayOut'?: boolean;
|
||||
/**
|
||||
* Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.
|
||||
*/
|
||||
'enableRealTimeUpdate'?: boolean;
|
||||
/**
|
||||
* When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
|
||||
*/
|
||||
'enableRecurring'?: boolean;
|
||||
/**
|
||||
* The type of the entity the payment is processed for.
|
||||
*/
|
||||
'entityType'?: PaymentRequest.EntityTypeEnum;
|
||||
/**
|
||||
* An integer value that is added to the normal fraud score. The value can be either positive or negative.
|
||||
*/
|
||||
'fraudOffset'?: number;
|
||||
'installments'?: Installments;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'lineItems'?: Array<LineItem>;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The merchant account identifier, with which you want to process the transaction.
|
||||
*/
|
||||
'merchantAccount': string;
|
||||
/**
|
||||
* 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;
|
||||
'merchantRiskIndicator'?: MerchantRiskIndicator;
|
||||
/**
|
||||
* 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'?: object;
|
||||
'mpiData'?: ThreeDSecureData;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The collection that contains the type of the payment method and its specific information (e.g. `idealIssuer`).
|
||||
*/
|
||||
'paymentMethod': object;
|
||||
/**
|
||||
* Date after which no further authorisations shall be performed. Only for 3D Secure 2.
|
||||
*/
|
||||
'recurringExpiry'?: string;
|
||||
/**
|
||||
* Minimum number of days between authorisations. Only for 3D Secure 2.
|
||||
*/
|
||||
'recurringFrequency'?: string;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'recurringProcessingModel'?: PaymentRequest.RecurringProcessingModelEnum;
|
||||
/**
|
||||
* Specifies the redirect method (GET or POST) when redirecting back from the issuer.
|
||||
*/
|
||||
'redirectFromIssuerMethod'?: string;
|
||||
/**
|
||||
* Specifies the redirect method (GET or POST) when redirecting to the issuer.
|
||||
*/
|
||||
'redirectToIssuerMethod'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The URL to return to.
|
||||
*/
|
||||
'returnUrl': string;
|
||||
/**
|
||||
* The maximum validity of the session.
|
||||
*/
|
||||
'sessionValidity'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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'?: PaymentRequest.ShopperInteractionEnum;
|
||||
/**
|
||||
* The combination of a language code and a country code to specify the language to be used in the payment.
|
||||
*/
|
||||
'shopperLocale'?: string;
|
||||
'shopperName'?: Name;
|
||||
/**
|
||||
* The shopper\'s reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments.
|
||||
*/
|
||||
'shopperReference'?: string;
|
||||
/**
|
||||
* The text to appear on the shopper\'s bank statement.
|
||||
*/
|
||||
'shopperStatement'?: string;
|
||||
/**
|
||||
* The shopper\'s social security number.
|
||||
*/
|
||||
'socialSecurityNumber'?: string;
|
||||
/**
|
||||
* The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.
|
||||
*/
|
||||
'splits'?: Array<Split>;
|
||||
/**
|
||||
* When true and `shopperReference` is provided, the payment details will be stored.
|
||||
*/
|
||||
'storePaymentMethod'?: boolean;
|
||||
/**
|
||||
* The shopper\'s telephone number.
|
||||
*/
|
||||
'telephoneNumber'?: string;
|
||||
'threeDS2RequestData'?: ThreeDS2RequestData;
|
||||
/**
|
||||
* If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/native-3ds2/authentication-only), and not the payment authorisation.
|
||||
*/
|
||||
'threeDSAuthenticationOnly'?: boolean;
|
||||
/**
|
||||
* Set to true if the payment should be routed to a trusted MID.
|
||||
*/
|
||||
'trustedShopper'?: boolean;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "accountInfo",
|
||||
"baseName": "accountInfo",
|
||||
"type": "AccountInfo"
|
||||
},
|
||||
{
|
||||
"name": "additionalData",
|
||||
"baseName": "additionalData",
|
||||
"type": "AdditionalData"
|
||||
},
|
||||
{
|
||||
"name": "amount",
|
||||
"baseName": "amount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "applicationInfo",
|
||||
"baseName": "applicationInfo",
|
||||
"type": "ApplicationInfo"
|
||||
},
|
||||
{
|
||||
"name": "billingAddress",
|
||||
"baseName": "billingAddress",
|
||||
"type": "Address"
|
||||
},
|
||||
{
|
||||
"name": "browserInfo",
|
||||
"baseName": "browserInfo",
|
||||
"type": "BrowserInfo"
|
||||
},
|
||||
{
|
||||
"name": "captureDelayHours",
|
||||
"baseName": "captureDelayHours",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "channel",
|
||||
"baseName": "channel",
|
||||
"type": "PaymentRequest.ChannelEnum"
|
||||
},
|
||||
{
|
||||
"name": "company",
|
||||
"baseName": "company",
|
||||
"type": "Company"
|
||||
},
|
||||
{
|
||||
"name": "countryCode",
|
||||
"baseName": "countryCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "dateOfBirth",
|
||||
"baseName": "dateOfBirth",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "dccQuote",
|
||||
"baseName": "dccQuote",
|
||||
"type": "ForexQuote"
|
||||
},
|
||||
{
|
||||
"name": "deliveryAddress",
|
||||
"baseName": "deliveryAddress",
|
||||
"type": "Address"
|
||||
},
|
||||
{
|
||||
"name": "deliveryDate",
|
||||
"baseName": "deliveryDate",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "deviceFingerprint",
|
||||
"baseName": "deviceFingerprint",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "enableOneClick",
|
||||
"baseName": "enableOneClick",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "enablePayOut",
|
||||
"baseName": "enablePayOut",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "enableRealTimeUpdate",
|
||||
"baseName": "enableRealTimeUpdate",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "enableRecurring",
|
||||
"baseName": "enableRecurring",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "entityType",
|
||||
"baseName": "entityType",
|
||||
"type": "PaymentRequest.EntityTypeEnum"
|
||||
},
|
||||
{
|
||||
"name": "fraudOffset",
|
||||
"baseName": "fraudOffset",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "installments",
|
||||
"baseName": "installments",
|
||||
"type": "Installments"
|
||||
},
|
||||
{
|
||||
"name": "lineItems",
|
||||
"baseName": "lineItems",
|
||||
"type": "Array<LineItem>"
|
||||
},
|
||||
{
|
||||
"name": "mcc",
|
||||
"baseName": "mcc",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantAccount",
|
||||
"baseName": "merchantAccount",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantOrderReference",
|
||||
"baseName": "merchantOrderReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantRiskIndicator",
|
||||
"baseName": "merchantRiskIndicator",
|
||||
"type": "MerchantRiskIndicator"
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"baseName": "metadata",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "mpiData",
|
||||
"baseName": "mpiData",
|
||||
"type": "ThreeDSecureData"
|
||||
},
|
||||
{
|
||||
"name": "orderReference",
|
||||
"baseName": "orderReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "origin",
|
||||
"baseName": "origin",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "paymentMethod",
|
||||
"baseName": "paymentMethod",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "recurringExpiry",
|
||||
"baseName": "recurringExpiry",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "recurringFrequency",
|
||||
"baseName": "recurringFrequency",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "recurringProcessingModel",
|
||||
"baseName": "recurringProcessingModel",
|
||||
"type": "PaymentRequest.RecurringProcessingModelEnum"
|
||||
},
|
||||
{
|
||||
"name": "redirectFromIssuerMethod",
|
||||
"baseName": "redirectFromIssuerMethod",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "redirectToIssuerMethod",
|
||||
"baseName": "redirectToIssuerMethod",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "reference",
|
||||
"baseName": "reference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "returnUrl",
|
||||
"baseName": "returnUrl",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "sessionValidity",
|
||||
"baseName": "sessionValidity",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperEmail",
|
||||
"baseName": "shopperEmail",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperIP",
|
||||
"baseName": "shopperIP",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperInteraction",
|
||||
"baseName": "shopperInteraction",
|
||||
"type": "PaymentRequest.ShopperInteractionEnum"
|
||||
},
|
||||
{
|
||||
"name": "shopperLocale",
|
||||
"baseName": "shopperLocale",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperName",
|
||||
"baseName": "shopperName",
|
||||
"type": "Name"
|
||||
},
|
||||
{
|
||||
"name": "shopperReference",
|
||||
"baseName": "shopperReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperStatement",
|
||||
"baseName": "shopperStatement",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "socialSecurityNumber",
|
||||
"baseName": "socialSecurityNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "splits",
|
||||
"baseName": "splits",
|
||||
"type": "Array<Split>"
|
||||
},
|
||||
{
|
||||
"name": "storePaymentMethod",
|
||||
"baseName": "storePaymentMethod",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "telephoneNumber",
|
||||
"baseName": "telephoneNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "threeDS2RequestData",
|
||||
"baseName": "threeDS2RequestData",
|
||||
"type": "ThreeDS2RequestData"
|
||||
},
|
||||
{
|
||||
"name": "threeDSAuthenticationOnly",
|
||||
"baseName": "threeDSAuthenticationOnly",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "trustedShopper",
|
||||
"baseName": "trustedShopper",
|
||||
"type": "boolean"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentRequest.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace PaymentRequest {
|
||||
export enum ChannelEnum {
|
||||
IOS = <any> 'iOS',
|
||||
Android = <any> 'Android',
|
||||
Web = <any> 'Web'
|
||||
}
|
||||
export enum EntityTypeEnum {
|
||||
NaturalPerson = <any> 'NaturalPerson',
|
||||
CompanyName = <any> 'CompanyName'
|
||||
}
|
||||
export enum RecurringProcessingModelEnum {
|
||||
CardOnFile = <any> 'CardOnFile',
|
||||
Subscription = <any> 'Subscription',
|
||||
UnscheduledCardOnFile = <any> 'UnscheduledCardOnFile'
|
||||
}
|
||||
export enum ShopperInteractionEnum {
|
||||
Ecommerce = <any> 'Ecommerce',
|
||||
ContAuth = <any> 'ContAuth',
|
||||
Moto = <any> 'Moto',
|
||||
POS = <any> 'POS'
|
||||
}
|
||||
}
|
||||
@@ -1,151 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { CheckoutPaymentsAction } from './checkoutPaymentsAction';
|
||||
import { FraudResult } from './fraudResult';
|
||||
import { InputDetail } from './inputDetail';
|
||||
import { Redirect } from './redirect';
|
||||
|
||||
export class PaymentResponse {
|
||||
'action'?: CheckoutPaymentsAction;
|
||||
/**
|
||||
* 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**.
|
||||
*/
|
||||
'additionalData'?: object;
|
||||
/**
|
||||
* Contains `threeds2.fingerprint` or `threeds2.challengeToken` values to be used in further calls to `/payments/details` endpoint.
|
||||
*/
|
||||
'authentication'?: object;
|
||||
/**
|
||||
* When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.
|
||||
*/
|
||||
'details'?: Array<InputDetail>;
|
||||
'fraudResult'?: FraudResult;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Contains the details that will be presented to the shopper.
|
||||
*/
|
||||
'outputDetails'?: object;
|
||||
/**
|
||||
* When non-empty, contains a value that you must submit to the `/payments/details` endpoint.
|
||||
*/
|
||||
'paymentData'?: string;
|
||||
/**
|
||||
* 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;
|
||||
'redirect'?: Redirect;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'refusalReason'?: string;
|
||||
/**
|
||||
* Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
|
||||
*/
|
||||
'refusalReasonCode'?: string;
|
||||
/**
|
||||
* 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 on handling a pending payment, refer to [Payments with pending status](https://docs.adyen.com/development-resources/payments-with-pending-status). * **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'?: PaymentResponse.ResultCodeEnum;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "action",
|
||||
"baseName": "action",
|
||||
"type": "CheckoutPaymentsAction"
|
||||
},
|
||||
{
|
||||
"name": "additionalData",
|
||||
"baseName": "additionalData",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "authentication",
|
||||
"baseName": "authentication",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "details",
|
||||
"baseName": "details",
|
||||
"type": "Array<InputDetail>"
|
||||
},
|
||||
{
|
||||
"name": "fraudResult",
|
||||
"baseName": "fraudResult",
|
||||
"type": "FraudResult"
|
||||
},
|
||||
{
|
||||
"name": "merchantReference",
|
||||
"baseName": "merchantReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "outputDetails",
|
||||
"baseName": "outputDetails",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "paymentData",
|
||||
"baseName": "paymentData",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "pspReference",
|
||||
"baseName": "pspReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "redirect",
|
||||
"baseName": "redirect",
|
||||
"type": "Redirect"
|
||||
},
|
||||
{
|
||||
"name": "refusalReason",
|
||||
"baseName": "refusalReason",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "refusalReasonCode",
|
||||
"baseName": "refusalReasonCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "resultCode",
|
||||
"baseName": "resultCode",
|
||||
"type": "PaymentResponse.ResultCodeEnum"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentResponse.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace PaymentResponse {
|
||||
export enum ResultCodeEnum {
|
||||
AuthenticationFinished = <any> 'AuthenticationFinished',
|
||||
Authorised = <any> 'Authorised',
|
||||
Cancelled = <any> 'Cancelled',
|
||||
ChallengeShopper = <any> 'ChallengeShopper',
|
||||
Error = <any> 'Error',
|
||||
IdentifyShopper = <any> 'IdentifyShopper',
|
||||
Pending = <any> 'Pending',
|
||||
PresentToShopper = <any> 'PresentToShopper',
|
||||
Received = <any> 'Received',
|
||||
RedirectShopper = <any> 'RedirectShopper',
|
||||
Refused = <any> 'Refused'
|
||||
}
|
||||
}
|
||||
@@ -1,478 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { Address } from './address';
|
||||
import { Amount } from './amount';
|
||||
import { ApplicationInfo } from './applicationInfo';
|
||||
import { Company } from './company';
|
||||
import { Configuration } from './configuration';
|
||||
import { ForexQuote } from './forexQuote';
|
||||
import { Installments } from './installments';
|
||||
import { LineItem } from './lineItem';
|
||||
import { Name } from './name';
|
||||
import { Split } from './split';
|
||||
import {AdditionalData3DSecure} from "../payments/additionalData3DSecure";
|
||||
import {AdditionalDataAirline} from "../payments/additionalDataAirline";
|
||||
import {AdditionalDataCommon} from "../payments/additionalDataCommon";
|
||||
import {AdditionalDataLevel23} from "../payments/additionalDataLevel23";
|
||||
import {AdditionalDataLodging} from "../payments/additionalDataLodging";
|
||||
import {AdditionalDataOpenInvoice} from "../payments/additionalDataOpenInvoice";
|
||||
import {AdditionalDataRatepay} from "../payments/additionalDataRatepay";
|
||||
import {AdditionalDataRetry} from "../payments/additionalDataRetry";
|
||||
import {AdditionalDataRisk} from "../payments/additionalDataRisk";
|
||||
import {AdditionalDataRiskStandalone} from "../payments/additionalDataRiskStandalone";
|
||||
import {AdditionalDataTemporaryServices} from "../payments/additionalDataTemporaryServices";
|
||||
import {AdditionalDataWallets} from "../payments/additionalDataWallets";
|
||||
|
||||
type AdditionalData = AdditionalData3DSecure | AdditionalDataAirline | AdditionalDataCommon | AdditionalDataLevel23 | AdditionalDataLodging | AdditionalDataOpenInvoice | AdditionalDataRatepay | AdditionalDataRetry | AdditionalDataRisk | AdditionalDataRiskStandalone | AdditionalDataTemporaryServices | AdditionalDataWallets;
|
||||
export class PaymentSetupRequest {
|
||||
/**
|
||||
* 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'?: AdditionalData;
|
||||
/**
|
||||
* List of payments methods to be presented to the shopper. To refer to payment methods, use their `brandCode` from [Payment methods overview](https://docs.adyen.com/payment-methods).
|
||||
*/
|
||||
'allowedPaymentMethods'?: Array<string>;
|
||||
'amount': Amount;
|
||||
'applicationInfo'?: ApplicationInfo;
|
||||
'billingAddress'?: Address;
|
||||
/**
|
||||
* List of payments methods to be hidden from the shopper. To refer to payment methods, use their `brandCode` from [Payment methods overview](https://docs.adyen.com/payment-methods).
|
||||
*/
|
||||
'blockedPaymentMethods'?: Array<string>;
|
||||
/**
|
||||
* The delay between the authorisation and scheduled auto-capture, specified in hours.
|
||||
*/
|
||||
'captureDelayHours'?: number;
|
||||
/**
|
||||
* 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'?: PaymentSetupRequest.ChannelEnum;
|
||||
'company'?: Company;
|
||||
'configuration'?: Configuration;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The shopper\'s date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
|
||||
*/
|
||||
'dateOfBirth'?: Date;
|
||||
'dccQuote'?: ForexQuote;
|
||||
'deliveryAddress'?: Address;
|
||||
/**
|
||||
* 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'?: Date;
|
||||
/**
|
||||
* When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
|
||||
*/
|
||||
'enableOneClick'?: boolean;
|
||||
/**
|
||||
* When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
|
||||
*/
|
||||
'enablePayOut'?: boolean;
|
||||
/**
|
||||
* Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.
|
||||
*/
|
||||
'enableRealTimeUpdate'?: boolean;
|
||||
/**
|
||||
* When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
|
||||
*/
|
||||
'enableRecurring'?: boolean;
|
||||
/**
|
||||
* The type of the entity the payment is processed for.
|
||||
*/
|
||||
'entityType'?: PaymentSetupRequest.EntityTypeEnum;
|
||||
/**
|
||||
* An integer value that is added to the normal fraud score. The value can be either positive or negative.
|
||||
*/
|
||||
'fraudOffset'?: number;
|
||||
'installments'?: Installments;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'lineItems'?: Array<LineItem>;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The merchant account identifier, with which you want to process the transaction.
|
||||
*/
|
||||
'merchantAccount': string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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'?: object;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* Required for the Web integration. Set this parameter to the origin URL of the page that you are loading the SDK from.
|
||||
*/
|
||||
'origin'?: string;
|
||||
/**
|
||||
* Date after which no further authorisations shall be performed. Only for 3D Secure 2.
|
||||
*/
|
||||
'recurringExpiry'?: string;
|
||||
/**
|
||||
* Minimum number of days between authorisations. Only for 3D Secure 2.
|
||||
*/
|
||||
'recurringFrequency'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* The URL to return to.
|
||||
*/
|
||||
'returnUrl': string;
|
||||
/**
|
||||
* The version of the SDK you are using (for Web SDK integrations only).
|
||||
*/
|
||||
'sdkVersion'?: string;
|
||||
/**
|
||||
* The maximum validity of the session.
|
||||
*/
|
||||
'sessionValidity'?: string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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'?: PaymentSetupRequest.ShopperInteractionEnum;
|
||||
/**
|
||||
* The combination of a language code and a country code to specify the language to be used in the payment.
|
||||
*/
|
||||
'shopperLocale'?: string;
|
||||
'shopperName'?: Name;
|
||||
/**
|
||||
* The shopper\'s reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments.
|
||||
*/
|
||||
'shopperReference'?: string;
|
||||
/**
|
||||
* The text to appear on the shopper\'s bank statement.
|
||||
*/
|
||||
'shopperStatement'?: string;
|
||||
/**
|
||||
* The shopper\'s social security number.
|
||||
*/
|
||||
'socialSecurityNumber'?: string;
|
||||
/**
|
||||
* The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.
|
||||
*/
|
||||
'splits'?: Array<Split>;
|
||||
/**
|
||||
* When true and `shopperReference` is provided, the payment details will be stored.
|
||||
*/
|
||||
'storePaymentMethod'?: boolean;
|
||||
/**
|
||||
* The shopper\'s telephone number.
|
||||
*/
|
||||
'telephoneNumber'?: string;
|
||||
/**
|
||||
* If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/native-3ds2/authentication-only), and not the payment authorisation.
|
||||
*/
|
||||
'threeDSAuthenticationOnly'?: boolean;
|
||||
/**
|
||||
* The token obtained when initializing the SDK. > This parameter is required for iOS and Android; not required for Web.
|
||||
*/
|
||||
'token'?: string;
|
||||
/**
|
||||
* Set to true if the payment should be routed to a trusted MID.
|
||||
*/
|
||||
'trustedShopper'?: boolean;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "additionalData",
|
||||
"baseName": "additionalData",
|
||||
"type": "AdditionalData"
|
||||
},
|
||||
{
|
||||
"name": "allowedPaymentMethods",
|
||||
"baseName": "allowedPaymentMethods",
|
||||
"type": "Array<string>"
|
||||
},
|
||||
{
|
||||
"name": "amount",
|
||||
"baseName": "amount",
|
||||
"type": "Amount"
|
||||
},
|
||||
{
|
||||
"name": "applicationInfo",
|
||||
"baseName": "applicationInfo",
|
||||
"type": "ApplicationInfo"
|
||||
},
|
||||
{
|
||||
"name": "billingAddress",
|
||||
"baseName": "billingAddress",
|
||||
"type": "Address"
|
||||
},
|
||||
{
|
||||
"name": "blockedPaymentMethods",
|
||||
"baseName": "blockedPaymentMethods",
|
||||
"type": "Array<string>"
|
||||
},
|
||||
{
|
||||
"name": "captureDelayHours",
|
||||
"baseName": "captureDelayHours",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "channel",
|
||||
"baseName": "channel",
|
||||
"type": "PaymentSetupRequest.ChannelEnum"
|
||||
},
|
||||
{
|
||||
"name": "company",
|
||||
"baseName": "company",
|
||||
"type": "Company"
|
||||
},
|
||||
{
|
||||
"name": "configuration",
|
||||
"baseName": "configuration",
|
||||
"type": "Configuration"
|
||||
},
|
||||
{
|
||||
"name": "countryCode",
|
||||
"baseName": "countryCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "dateOfBirth",
|
||||
"baseName": "dateOfBirth",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "dccQuote",
|
||||
"baseName": "dccQuote",
|
||||
"type": "ForexQuote"
|
||||
},
|
||||
{
|
||||
"name": "deliveryAddress",
|
||||
"baseName": "deliveryAddress",
|
||||
"type": "Address"
|
||||
},
|
||||
{
|
||||
"name": "deliveryDate",
|
||||
"baseName": "deliveryDate",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "enableOneClick",
|
||||
"baseName": "enableOneClick",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "enablePayOut",
|
||||
"baseName": "enablePayOut",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "enableRealTimeUpdate",
|
||||
"baseName": "enableRealTimeUpdate",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "enableRecurring",
|
||||
"baseName": "enableRecurring",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "entityType",
|
||||
"baseName": "entityType",
|
||||
"type": "PaymentSetupRequest.EntityTypeEnum"
|
||||
},
|
||||
{
|
||||
"name": "fraudOffset",
|
||||
"baseName": "fraudOffset",
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"name": "installments",
|
||||
"baseName": "installments",
|
||||
"type": "Installments"
|
||||
},
|
||||
{
|
||||
"name": "lineItems",
|
||||
"baseName": "lineItems",
|
||||
"type": "Array<LineItem>"
|
||||
},
|
||||
{
|
||||
"name": "mcc",
|
||||
"baseName": "mcc",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantAccount",
|
||||
"baseName": "merchantAccount",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "merchantOrderReference",
|
||||
"baseName": "merchantOrderReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"baseName": "metadata",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "orderReference",
|
||||
"baseName": "orderReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "origin",
|
||||
"baseName": "origin",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "recurringExpiry",
|
||||
"baseName": "recurringExpiry",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "recurringFrequency",
|
||||
"baseName": "recurringFrequency",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "reference",
|
||||
"baseName": "reference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "returnUrl",
|
||||
"baseName": "returnUrl",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "sdkVersion",
|
||||
"baseName": "sdkVersion",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "sessionValidity",
|
||||
"baseName": "sessionValidity",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperEmail",
|
||||
"baseName": "shopperEmail",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperIP",
|
||||
"baseName": "shopperIP",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperInteraction",
|
||||
"baseName": "shopperInteraction",
|
||||
"type": "PaymentSetupRequest.ShopperInteractionEnum"
|
||||
},
|
||||
{
|
||||
"name": "shopperLocale",
|
||||
"baseName": "shopperLocale",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperName",
|
||||
"baseName": "shopperName",
|
||||
"type": "Name"
|
||||
},
|
||||
{
|
||||
"name": "shopperReference",
|
||||
"baseName": "shopperReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "shopperStatement",
|
||||
"baseName": "shopperStatement",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "socialSecurityNumber",
|
||||
"baseName": "socialSecurityNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "splits",
|
||||
"baseName": "splits",
|
||||
"type": "Array<Split>"
|
||||
},
|
||||
{
|
||||
"name": "storePaymentMethod",
|
||||
"baseName": "storePaymentMethod",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "telephoneNumber",
|
||||
"baseName": "telephoneNumber",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "threeDSAuthenticationOnly",
|
||||
"baseName": "threeDSAuthenticationOnly",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"name": "token",
|
||||
"baseName": "token",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "trustedShopper",
|
||||
"baseName": "trustedShopper",
|
||||
"type": "boolean"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentSetupRequest.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace PaymentSetupRequest {
|
||||
export enum ChannelEnum {
|
||||
IOS = <any> 'iOS',
|
||||
Android = <any> 'Android',
|
||||
Web = <any> 'Web'
|
||||
}
|
||||
export enum EntityTypeEnum {
|
||||
NaturalPerson = <any> 'NaturalPerson',
|
||||
CompanyName = <any> 'CompanyName'
|
||||
}
|
||||
export enum ShopperInteractionEnum {
|
||||
Ecommerce = <any> 'Ecommerce',
|
||||
ContAuth = <any> 'ContAuth',
|
||||
Moto = <any> 'Moto',
|
||||
POS = <any> 'POS'
|
||||
}
|
||||
}
|
||||
@@ -1,43 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { RecurringDetail } from './recurringDetail';
|
||||
|
||||
export class PaymentSetupResponse {
|
||||
/**
|
||||
* The encoded payment session that you need to pass to the SDK.
|
||||
*/
|
||||
'paymentSession'?: string;
|
||||
/**
|
||||
* The detailed list of stored payment details required to generate payment forms. Will be empty if oneClick is set to false in the request.
|
||||
*/
|
||||
'recurringDetails'?: Array<RecurringDetail>;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "paymentSession",
|
||||
"baseName": "paymentSession",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "recurringDetails",
|
||||
"baseName": "recurringDetails",
|
||||
"type": "Array<RecurringDetail>"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentSetupResponse.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class PaymentVerificationRequest {
|
||||
/**
|
||||
* Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.
|
||||
*/
|
||||
'payload': string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "payload",
|
||||
"baseName": "payload",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentVerificationRequest.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,125 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
import { FraudResult } from './fraudResult';
|
||||
import { ServiceError } from './serviceError';
|
||||
|
||||
export class PaymentVerificationResponse {
|
||||
/**
|
||||
* 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**.
|
||||
*/
|
||||
'additionalData'?: object;
|
||||
'fraudResult'?: FraudResult;
|
||||
/**
|
||||
* A unique value that you provided in the initial `/paymentSession` request as a `reference` field.
|
||||
*/
|
||||
'merchantReference': string;
|
||||
/**
|
||||
* The payment method used in the transaction.
|
||||
*/
|
||||
'paymentMethod': string;
|
||||
/**
|
||||
* 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;
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
'refusalReason'?: string;
|
||||
/**
|
||||
* Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
|
||||
*/
|
||||
'refusalReasonCode'?: string;
|
||||
/**
|
||||
* 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 on handling a pending payment, refer to [Payments with pending status](https://docs.adyen.com/development-resources/payments-with-pending-status). * **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'?: PaymentVerificationResponse.ResultCodeEnum;
|
||||
'serviceError'?: ServiceError;
|
||||
/**
|
||||
* The shopperLocale value provided in the payment request.
|
||||
*/
|
||||
'shopperLocale': string;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "additionalData",
|
||||
"baseName": "additionalData",
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"name": "fraudResult",
|
||||
"baseName": "fraudResult",
|
||||
"type": "FraudResult"
|
||||
},
|
||||
{
|
||||
"name": "merchantReference",
|
||||
"baseName": "merchantReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "paymentMethod",
|
||||
"baseName": "paymentMethod",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "pspReference",
|
||||
"baseName": "pspReference",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "refusalReason",
|
||||
"baseName": "refusalReason",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "refusalReasonCode",
|
||||
"baseName": "refusalReasonCode",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "resultCode",
|
||||
"baseName": "resultCode",
|
||||
"type": "PaymentVerificationResponse.ResultCodeEnum"
|
||||
},
|
||||
{
|
||||
"name": "serviceError",
|
||||
"baseName": "serviceError",
|
||||
"type": "ServiceError"
|
||||
},
|
||||
{
|
||||
"name": "shopperLocale",
|
||||
"baseName": "shopperLocale",
|
||||
"type": "string"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return PaymentVerificationResponse.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace PaymentVerificationResponse {
|
||||
export enum ResultCodeEnum {
|
||||
AuthenticationFinished = <any> 'AuthenticationFinished',
|
||||
Authorised = <any> 'Authorised',
|
||||
Cancelled = <any> 'Cancelled',
|
||||
ChallengeShopper = <any> 'ChallengeShopper',
|
||||
Error = <any> 'Error',
|
||||
IdentifyShopper = <any> 'IdentifyShopper',
|
||||
Pending = <any> 'Pending',
|
||||
PresentToShopper = <any> 'PresentToShopper',
|
||||
Received = <any> 'Received',
|
||||
RedirectShopper = <any> 'RedirectShopper',
|
||||
Refused = <any> 'Refused'
|
||||
}
|
||||
}
|
||||
@@ -1,80 +0,0 @@
|
||||
/**
|
||||
* 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 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 ```
|
||||
*
|
||||
* The version of the OpenAPI document: 51
|
||||
* Contact: support@adyen.com
|
||||
*
|
||||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||||
* https://openapi-generator.tech
|
||||
* Do not edit the class manually.
|
||||
*/
|
||||
|
||||
|
||||
export class Recurring {
|
||||
/**
|
||||
* 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).
|
||||
*/
|
||||
'contract'?: Recurring.ContractEnum;
|
||||
/**
|
||||
* A descriptive name for this detail.
|
||||
*/
|
||||
'recurringDetailName'?: string;
|
||||
/**
|
||||
* Date after which no further authorisations shall be performed. Only for 3D Secure 2.
|
||||
*/
|
||||
'recurringExpiry'?: Date;
|
||||
/**
|
||||
* Minimum number of days between authorisations. Only for 3D Secure 2.
|
||||
*/
|
||||
'recurringFrequency'?: string;
|
||||
/**
|
||||
* The name of the token service.
|
||||
*/
|
||||
'tokenService'?: Recurring.TokenServiceEnum;
|
||||
|
||||
static discriminator: string | undefined = undefined;
|
||||
|
||||
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
||||
{
|
||||
"name": "contract",
|
||||
"baseName": "contract",
|
||||
"type": "Recurring.ContractEnum"
|
||||
},
|
||||
{
|
||||
"name": "recurringDetailName",
|
||||
"baseName": "recurringDetailName",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "recurringExpiry",
|
||||
"baseName": "recurringExpiry",
|
||||
"type": "Date"
|
||||
},
|
||||
{
|
||||
"name": "recurringFrequency",
|
||||
"baseName": "recurringFrequency",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "tokenService",
|
||||
"baseName": "tokenService",
|
||||
"type": "Recurring.TokenServiceEnum"
|
||||
} ];
|
||||
|
||||
static getAttributeTypeMap() {
|
||||
return Recurring.attributeTypeMap;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace Recurring {
|
||||
export enum ContractEnum {
|
||||
ONECLICK = <any> 'ONECLICK',
|
||||
RECURRING = <any> 'RECURRING',
|
||||
PAYOUT = <any> 'PAYOUT'
|
||||
}
|
||||
export enum TokenServiceEnum {
|
||||
VISATOKENSERVICE = <any> 'VISATOKENSERVICE',
|
||||
MCTOKENSERVICE = <any> 'MCTOKENSERVICE'
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user