Merge pull request #1565 from Adyen/add-openbanking-api

Add Open Banking API

Author: gcatanese

README.md

@@ -24,6 +24,7 @@ This library supports the following:
 | [Legal Entity Management API](https://docs.adyen.com/api-explorer/legalentity/3/overview)                  |     v3      | Manage legal entities that contain information required for verification.                                                                                                                                                                                                                                                                | [LegalEntityManagement](/src/services/legalEntityManagement/index.ts)                                                                                                   |
 | [Local/Cloud-based Terminal API](https://docs.adyen.com/point-of-sale/terminal-api-reference)              |      -      | Our point-of-sale integration.                                                                                                                                                                                                                                                                                                           | [TerminalLocalAPI](/src/services/terminalLocalAPI.ts) or [TerminalCloudAPI](/src/services/terminalCloudAPI.ts) |
 | [Management API](https://docs.adyen.com/api-explorer/Management/3/overview)                                |     v3      | Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.                                                                                                                                                                                                                                            | [Management](/src/services/management/index.ts)                                                                                                                         |
+| [Open Banking API](https://docs.adyen.com/api-explorer/open-banking/1/overview)                                |     v1      | The Open Banking API provides secure endpoints to share financial data and services with third parties.                                                                                                                                                                                                                                          | [Open Banking](/src/services/openbanking/index.ts)                                                                                                                         |
 | [Payments API](https://docs.adyen.com/api-explorer/Payment/68/overview)                                    |     v68     | Our classic integration for online payments.                                                                                                                                                                                                                                                                                             | [ClassicIntegrationAPI](/src/services/paymentApi.ts)                                                                                                                    |
 | [Payouts API](https://docs.adyen.com/api-explorer/Payout/68/overview)                                      |     v68     | Endpoints for sending funds to your customers.                                                                                                                                                                                                                                                                                           | [Payout](/src/services/payout/index.ts)                                                                                                                                 |
 | [Platforms APIs](https://docs.adyen.com/platforms/api)                                                     |      -      | Set of APIs when using Adyen for Platforms. This API is used for the classic integration.                                                                                                                                                                                                                                                | [Platforms](/src/services/platforms.ts)                                                                                                                                 |

src/__tests__/openBanking.spec.ts

@@ -0,0 +1,104 @@
+import nock from "nock";
+import Client from "../client";
+import { createClient } from "../__mocks__/base";
+import { AccountVerificationApi } from "../services/openBanking/accountVerificationApi";
+import {
+    AccountType,
+    AccountVerificationCountry,
+    AccountVerificationReportResponse,
+    AccountVerificationRoutesRequest,
+    AccountVerificationRoutesResponse,
+    PartyRole,
+} from "../typings/openBanking/models";
+
+let client: Client;
+let accountVerificationApi: AccountVerificationApi;
+let scope: nock.Scope;
+
+beforeEach((): void => {
+    if (!nock.isActive()) {
+        nock.activate();
+    }
+    client = createClient();
+    scope = nock("https://obgateway-test.adyen.com/obgateway/v1");
+    accountVerificationApi = new AccountVerificationApi(client);
+});
+
+afterEach(() => {
+    nock.cleanAll();
+});
+
+describe("Open Banking", (): void => {
+    it("should create account verification routes", async (): Promise<void> => {
+        const request: AccountVerificationRoutesRequest = {
+            country: AccountVerificationCountry.Nl,
+            locale: "en-US",
+            state: "11a1e60a-18b0-4dda-9258-e0ae29e1e2a3",
+            redirectUrl: "https://merchanturl.example.org/redirect/url",
+        };
+
+        const mockResponse: AccountVerificationRoutesResponse = {
+            routes: [
+                {
+                    provider: {
+                        name: "Tink",
+                        logoURL: "https://obgateway.adyen.com/obgateway/static/provider/images/tink-logo.svg",
+                    },
+                    link: "https://obgateway.adyen.com/obgateway/provider/outgoing/tink/redirect/13ec4802-c987-4f8c-8909-9a75ff567256",
+                },
+            ],
+        };
+
+        scope.post("/accountVerification/routes")
+            .reply(200, mockResponse);
+
+        const response = await accountVerificationApi.createAccountVerificationRoutes(request);
+
+        expect(response.routes.length).toBe(1);
+        expect(response.routes[0].link).toEqual("https://obgateway.adyen.com/obgateway/provider/outgoing/tink/redirect/13ec4802-c987-4f8c-8909-9a75ff567256");
+    });
+
+    it("should get account verification report", async (): Promise<void> => {
+        const code = "some_code";  
+        const mockResponse: AccountVerificationReportResponse = {
+            id: "69ee9452ef824fe092f1417f37535755",
+            country: AccountVerificationCountry.Es,
+            accounts: [
+                {
+                    accountId: "ed5080e4f485430290475d246534c8fd",
+                    accountType: AccountType.Current,
+                    accountName: "Checking Account 1",
+                    accountNumber: "ES1376230223254275408743",
+                    currency: "EUR",
+                    identifiers: {
+                        iban: {
+                            iban: "ES1376230223254275408743",
+                            bban: "76230223254275408743",
+                            bic: "BIC001"
+                        },
+                    },
+                    parties: [
+                        {
+                            identity: {
+                                fullLegalName: "Alberta Bobbeth Charleson",
+                                name: "Alberta Bobbeth Charleson",
+                            },
+                            role: PartyRole.Holder,
+                        },
+                    ],
+                    bankName: "Tink Demo Bank",
+                },
+            ],
+        };
+
+        scope.get(`/accountVerification/reports/${code}`)
+            .reply(200, mockResponse);
+
+        const response = await accountVerificationApi.getAccountVerificationReport(code);
+
+        expect(response.id).toEqual("69ee9452ef824fe092f1417f37535755");
+        expect(response.country).toEqual(AccountVerificationCountry.Es);
+        expect(response.accounts.length).toBe(1);
+
+    });
+});

src/services/openBanking/accountVerificationApi.ts

@@ -0,0 +1,75 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+
+import getJsonResponse from "../../helpers/getJsonResponse";
+import Service from "../../service";
+import Client from "../../client";
+import { IRequest } from "../../typings/requestOptions";
+import Resource from "../resource";
+
+import { ObjectSerializer } from "../../typings/openBanking/objectSerializer";
+import { AccountVerificationReportResponse } from "../../typings/openBanking/models";
+import { AccountVerificationRoutesRequest } from "../../typings/openBanking/models";
+import { AccountVerificationRoutesResponse } from "../../typings/openBanking/models";
+
+/**
+ * API handler for AccountVerificationApi
+ */
+export class AccountVerificationApi extends Service {
+
+    private readonly API_BASEPATH: string = "https://obgateway-test.adyen.com/obgateway/v1";
+    private baseUrl: string;
+
+    public constructor(client: Client){
+        super(client);
+        this.baseUrl = this.createBaseUrl(this.API_BASEPATH);
+    }
+
+    /**
+    * @summary Create routes for account verification
+    * @param accountVerificationRoutesRequest {@link AccountVerificationRoutesRequest } 
+    * @param requestOptions {@link IRequest.Options }
+    * @return {@link AccountVerificationRoutesResponse }
+    */
+    public async createAccountVerificationRoutes(accountVerificationRoutesRequest: AccountVerificationRoutesRequest, requestOptions?: IRequest.Options): Promise<AccountVerificationRoutesResponse> {
+        const endpoint = `${this.baseUrl}/accountVerification/routes`;
+        const resource = new Resource(this, endpoint);
+        
+        const request: AccountVerificationRoutesRequest = ObjectSerializer.serialize(accountVerificationRoutesRequest, "AccountVerificationRoutesRequest");
+        const response = await getJsonResponse<AccountVerificationRoutesRequest, AccountVerificationRoutesResponse>(
+            resource,
+            request,
+            { ...requestOptions, method: "POST" }
+        );
+
+        return ObjectSerializer.deserialize(response, "AccountVerificationRoutesResponse");
+    }
+
+    /**
+    * @summary Get account verification report
+    * @param code {@link string } The unique code you receive after a successful open banking flow that is included as a query parameter in the &#x60;redirectUrl&#x60; callback.
+    * @param requestOptions {@link IRequest.Options }
+    * @return {@link AccountVerificationReportResponse }
+    */
+    public async getAccountVerificationReport(code: string, requestOptions?: IRequest.Options): Promise<AccountVerificationReportResponse> {
+        const endpoint = `${this.baseUrl}/accountVerification/reports/{code}`
+            .replace("{" + "code" + "}", encodeURIComponent(String(code)));
+        const resource = new Resource(this, endpoint);
+        
+        const response = await getJsonResponse<string, AccountVerificationReportResponse>(
+            resource,
+            "",
+            { ...requestOptions, method: "GET" }
+        );
+
+        return ObjectSerializer.deserialize(response, "AccountVerificationReportResponse");
+    }
+
+}

src/services/openBanking/index.ts

@@ -0,0 +1,24 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+import { AccountVerificationApi } from "./accountVerificationApi";
+
+import Service from "../../service";
+import Client from "../../client";
+
+export default class OpenBankingAPI extends Service {
+    
+    public constructor(client: Client) {
+        super(client);
+    }
+
+    public get AccountVerificationApi() {
+        return new AccountVerificationApi(this.client);
+    }
+}

src/typings/openBanking/aCHAccountIdentifier.ts

@@ -0,0 +1,46 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+
+export class ACHAccountIdentifier {
+    /**
+    * The account number of the bank account.
+    */
+    "accountNumber": string;
+    /**
+    * The [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace.
+    */
+    "routingNumber": string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "accountNumber",
+            "baseName": "accountNumber",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "routingNumber",
+            "baseName": "routingNumber",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ACHAccountIdentifier.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

src/typings/openBanking/accountIdentifiers.ts

@@ -0,0 +1,75 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+import { ACHAccountIdentifier } from "./aCHAccountIdentifier";
+import { BACSAccountIdentifier } from "./bACSAccountIdentifier";
+import { BSBAccountIdentifier } from "./bSBAccountIdentifier";
+import { EFTAccountIdentifier } from "./eFTAccountIdentifier";
+import { IBANAccountIdentifier } from "./iBANAccountIdentifier";
+import { RIXAccountIdentifier } from "./rIXAccountIdentifier";
+
+
+export class AccountIdentifiers {
+    "ach"?: ACHAccountIdentifier | null;
+    "bacs"?: BACSAccountIdentifier | null;
+    "bsb"?: BSBAccountIdentifier | null;
+    "eft"?: EFTAccountIdentifier | null;
+    "iban"?: IBANAccountIdentifier | null;
+    "rix"?: RIXAccountIdentifier | null;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "ach",
+            "baseName": "ach",
+            "type": "ACHAccountIdentifier | null",
+            "format": ""
+        },
+        {
+            "name": "bacs",
+            "baseName": "bacs",
+            "type": "BACSAccountIdentifier | null",
+            "format": ""
+        },
+        {
+            "name": "bsb",
+            "baseName": "bsb",
+            "type": "BSBAccountIdentifier | null",
+            "format": ""
+        },
+        {
+            "name": "eft",
+            "baseName": "eft",
+            "type": "EFTAccountIdentifier | null",
+            "format": ""
+        },
+        {
+            "name": "iban",
+            "baseName": "iban",
+            "type": "IBANAccountIdentifier | null",
+            "format": ""
+        },
+        {
+            "name": "rix",
+            "baseName": "rix",
+            "type": "RIXAccountIdentifier | null",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AccountIdentifiers.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

src/typings/openBanking/accountParty.ts

@@ -0,0 +1,45 @@
+/*
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+import { Identity } from "./identity";
+import { PartyRole } from "./partyRole";
+
+
+export class AccountParty {
+    "identity": Identity;
+    "role": PartyRole;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "identity",
+            "baseName": "identity",
+            "type": "Identity",
+            "format": ""
+        },
+        {
+            "name": "role",
+            "baseName": "role",
+            "type": "PartyRole",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AccountParty.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+export namespace AccountParty {
+}