diff --git a/generator/konfig-docs/src/pages/sdk/companies.json b/generator/konfig-docs/src/pages/sdk/companies.json index 851b48858c..f5b0fc6a35 100644 --- a/generator/konfig-docs/src/pages/sdk/companies.json +++ b/generator/konfig-docs/src/pages/sdk/companies.json @@ -895,6 +895,28 @@ "difficultyScore": 483, "subpath": "/sdk/click-up" }, + { + "parentCategories": [ + "Data" + ], + "subCategories": [ + "Finance" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/linkcy/favicon.png", + "metaDescription": "LinkCy is the White Label Banking solution (via App or API) for Global Market in Europe.\n\nIts Plug And Play service enables all Companies to offer accounts (IBANS) and payment cards (Visa / Mastercard) to their users without any regulatory burden, in just a few minutes, compared to 9 to 12 months of technical and regulatory development with other Banking As A Service (BAAS) platforms.\n\nLinkCy is a French fintech start-up incubated at Sation F with BNP Paribas & Plug And Play.", + "services": [], + "company": "LinkCy", + "keywords": [ + "fintech", + "banking", + "financial_technology", + "banking_as_a_service", + "white_label_banking" + ], + "numberOfApis": 1, + "difficultyScore": 474.5, + "subpath": "/sdk/link-cy" + }, { "parentCategories": [ "Commerce" @@ -1623,6 +1645,25 @@ "difficultyScore": 320, "subpath": "/sdk/intelli-hr" }, + { + "parentCategories": [ + "Commerce" + ], + "subCategories": [ + "Payment Processing" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/token/favicon.png", + "metaDescription": "With the simplest and fastest way to launch Pay by Bank as a core payment method globally, Token.io's complete A2A payment infrastructure helps payment providers grow their market share in the face of the continued shift from cards to APMs.\n\nToken.io delivers the highest performing and deepest connectivity in the industry, reaching 567 million bank accounts (80%+ per market) in 20 supported countries through a single API and interface.\n\nWith fast and flexible deployment options, including the option to use Token.io's license and conversion boosting payment authentication flows, payment providers can quickly and easily launch and manage Pay By Bank capabilities.\n\nToken.io's solution is proven by a blue-chip base of partners, which collectively process payments for tens of millions of merchants worldwide, including HSBC, Mastercard, BNP Paribas, ACI Worldwide, Total Processing, Computop, Nuvei and Paysafe.\n\nAs Token.io pushes the boundaries of innovation, it remains relentlessly focused on delivering infrastructure that enables payment providers to grow their business. Token.io also provides access to aggregated bank account and transaction data, enabling payment providers to enrich their services and reinvent financial experiences.\n\nToken.io is authorised as an AISP & PISP by the FCA in the UK and by BaFin in Germany. Token.io is PSD2 and SCA compliant, and PCI-DSS Level 1 and ISO27001:2013 Certified.\n\n— RECOGNISED BY —\n\n\"Token.io provides an innovative solution in the Open Banking payments landscape…\" — Juniper Research\n\"Token.io's strength is payment infrastructure…\" — Forrester\n\"One of the fastest growing fintechs of 2022… \" — Sifted\n\n🏆 Open Banking Platinum Innovation Award - Juniper Research 2023 and 2022\n🏆 Payments Tech of the Year - Europe Fintech Awards 2023\n🏆 Fintech for Good Award - Paytech Awards 2023\n🏆 Qorus-Capgemini NewTech Payments Bronze Award - 2023\n🏆 Payments Tech of the Year Award - Fintech Awards London 2022", + "services": [], + "company": "Token", + "keywords": [ + "open_banking", + "payments" + ], + "numberOfApis": 1, + "difficultyScore": 318.75, + "subpath": "/sdk/token" + }, { "parentCategories": [ "Business Intelligence" @@ -3048,6 +3089,25 @@ "difficultyScore": 135.5, "subpath": "/sdk/hsbc" }, + { + "parentCategories": [ + "Commerce" + ], + "subCategories": [ + "Payment Processing" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/edge/favicon.png", + "metaDescription": "We are building the gold standard in online payment infrastructure for merchants mis-labeled as high-risk.", + "services": [], + "company": "Edge", + "keywords": [ + "online_payments", + "financial_data_management" + ], + "numberOfApis": 1, + "difficultyScore": 135.25, + "subpath": "/sdk/edge" + }, { "parentCategories": [ "Human Resources" @@ -3445,6 +3505,26 @@ "difficultyScore": 110, "subpath": "/sdk/gladly" }, + { + "parentCategories": [ + "Artificial Intelligence" + ], + "subCategories": [ + "AI Tools" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/hypatos/favicon.png", + "metaDescription": "Balancing humans and machines to accelerate business.\n\nHypatos adds value to critical business operations using third wave AI and advanced automation technologies for document processing. By replacing routine and complex tasks with intelligent solutions, we are unlocking human potential and reshaping the workplace. As AI agents manage administrative tasks efficiently, accurately and cost effectively, people focus on strategic decisions and designing innovative solutions to bring business to the next level.\n\nData Protection Policy:\nhttps://www.hypatos.ai/privacy-policy", + "services": [], + "company": "Hypatos", + "keywords": [ + "machine_learning", + "ai", + "document_processing" + ], + "numberOfApis": 1, + "difficultyScore": 106.75, + "subpath": "/sdk/hypatos" + }, { "parentCategories": [ "Business Intelligence" @@ -3828,6 +3908,27 @@ "difficultyScore": 92.5, "subpath": "/sdk/epidemic-sound" }, + { + "parentCategories": [ + "Data" + ], + "subCategories": [ + "Finance" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/monto/favicon.png", + "metaDescription": "Monto is a Stockholm-based fintech that helps Nordic SME lenders harness the power of real-time data. We combine smart tech and deep industry know-how to help fintechs, banks, lending brokers and BaaS platforms make better credit decisions, streamline processes and improve the customer experience.\n\nWith Monto, lenders no longer have to rely on manual, dated or mediocre data sources in their credit reviews. Our API unlocks instant access to up-to-date income statements, ledger quality, financial ratios, and more, fetched from leading accounting software providers in Sweden. We also provide a visual interface that allows credit teams to gain a comprehensive financial understanding of their connected borrowers.\n\nOur platform is tech agnostic and available for a free trial.", + "services": [], + "company": "Monto", + "keywords": [ + "fintech", + "financial_data", + "lending", + "credit_decisions" + ], + "numberOfApis": 1, + "difficultyScore": 92.25, + "subpath": "/sdk/monto" + }, { "parentCategories": [ "Commerce" diff --git a/generator/konfig-docs/src/pages/sdk/edge/index.tsx b/generator/konfig-docs/src/pages/sdk/edge/index.tsx new file mode 100644 index 0000000000..f6f8e25f4e --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/edge/index.tsx @@ -0,0 +1,63 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Edge", + "numberOfMethods": 41, + "categories": [ + "online_payments", + "financial_data_management" + ], + "index": "edge/typescript", + "language": "TypeScript", + "link": "/sdk/edge/typescript/", + "developerDocumentation": "docs.tryedge.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/edge/openapi.yaml" + }, + { + "name": "Edge", + "numberOfMethods": 41, + "categories": [ + "online_payments", + "financial_data_management" + ], + "index": "edge/python", + "language": "Python", + "link": "/sdk/edge/python/", + "developerDocumentation": "docs.tryedge.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/edge/openapi.yaml" + }, + { + "name": "Edge", + "numberOfMethods": 41, + "categories": [ + "online_payments", + "financial_data_management" + ], + "index": "edge/java", + "language": "Java", + "link": "/sdk/edge/java/", + "developerDocumentation": "docs.tryedge.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/edge/openapi.yaml" + } +]; + +export default function Edge() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/edge/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/edge/typescript/_first-request.mdx new file mode 100644 index 0000000000..a86e0a8828 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/edge/typescript/_first-request.mdx @@ -0,0 +1,8 @@ +```typescript index.ts +// Show +const showIndividualAttachmentResponse = edge.attachments.showIndividualAttachment({ + id: "32e46c03-a4e1-53e7-93e4-936fad0196a1" + fields[records]: ["id","created_at","updated_at"] + include: ["a","a.b","c","c.d.e"] +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/edge/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/edge/typescript/_getting-started.mdx new file mode 100644 index 0000000000..31f08303b3 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/edge/typescript/_getting-started.mdx @@ -0,0 +1,7 @@ +```typescript index.ts +import { Edge } from 'edge-typescript-sdk'; + +const edge = new Edge({ + bearerAuth: "BEARER_AUTH" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/edge/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/edge/typescript/index.tsx new file mode 100644 index 0000000000..d2e525f5f5 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/edge/typescript/index.tsx @@ -0,0 +1,4027 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function EdgeTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/hypatos/index.tsx b/generator/konfig-docs/src/pages/sdk/hypatos/index.tsx new file mode 100644 index 0000000000..de16765ff6 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/hypatos/index.tsx @@ -0,0 +1,71 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Hypatos", + "numberOfMethods": 34, + "categories": [ + "machine_learning", + "ai", + "document_processing" + ], + "index": "hypatos/typescript", + "language": "TypeScript", + "link": "/sdk/hypatos/typescript/", + "developerDocumentation": "hypatos.redoc.ly/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/hypatos/openapi.yaml" + }, + { + "name": "Hypatos", + "numberOfMethods": 34, + "categories": [ + "machine_learning", + "ai", + "document_processing" + ], + "index": "hypatos/python", + "language": "Python", + "link": "/sdk/hypatos/python/", + "developerDocumentation": "hypatos.redoc.ly/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/hypatos/openapi.yaml" + }, + { + "name": "Hypatos", + "numberOfMethods": 34, + "categories": [ + "machine_learning", + "ai", + "document_processing" + ], + "index": "hypatos/java", + "language": "Java", + "link": "/sdk/hypatos/java/", + "developerDocumentation": "hypatos.redoc.ly/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/hypatos/openapi.yaml" + } +]; + +export default function Hypatos() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/hypatos/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/hypatos/typescript/_first-request.mdx new file mode 100644 index 0000000000..80146ee421 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/hypatos/typescript/_first-request.mdx @@ -0,0 +1,6 @@ +```typescript index.ts +// Request an access token +const requestAccessTokenResponse = hypatos.authorization.requestAccessToken({ + grant_type: "GRANT_TYPE" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/hypatos/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/hypatos/typescript/_getting-started.mdx new file mode 100644 index 0000000000..e14bec27af --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/hypatos/typescript/_getting-started.mdx @@ -0,0 +1,10 @@ +```typescript index.ts +import { Hypatos } from 'hypatos-typescript-sdk'; + +const hypatos = new Hypatos({ + clientId: "CLIENT_ID", + clientSecret: "CLIENT_SECRET", + username: "USERNAME", + password: "PASSWORD" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/hypatos/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/hypatos/typescript/index.tsx new file mode 100644 index 0000000000..da8d4fbcd5 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/hypatos/typescript/index.tsx @@ -0,0 +1,2060 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function HypatosTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/link-cy/index.tsx b/generator/konfig-docs/src/pages/sdk/link-cy/index.tsx new file mode 100644 index 0000000000..68cc29749b --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/link-cy/index.tsx @@ -0,0 +1,76 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "LinkCy", + "numberOfMethods": 102, + "categories": [ + "fintech", + "banking", + "financial_technology", + "banking_as_a_service", + "white_label_banking" + ], + "index": "link-cy/typescript", + "language": "TypeScript", + "link": "/sdk/link-cy/typescript/", + "developerDocumentation": "docs.sandbox.linkcy.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/linkcy/openapi.yaml" + }, + { + "name": "LinkCy", + "numberOfMethods": 102, + "categories": [ + "fintech", + "banking", + "financial_technology", + "banking_as_a_service", + "white_label_banking" + ], + "index": "link-cy/python", + "language": "Python", + "link": "/sdk/link-cy/python/", + "developerDocumentation": "docs.sandbox.linkcy.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/linkcy/openapi.yaml" + }, + { + "name": "LinkCy", + "numberOfMethods": 102, + "categories": [ + "fintech", + "banking", + "financial_technology", + "banking_as_a_service", + "white_label_banking" + ], + "index": "link-cy/java", + "language": "Java", + "link": "/sdk/link-cy/java/", + "developerDocumentation": "docs.sandbox.linkcy.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/linkcy/openapi.yaml" + } +]; + +export default function LinkCy() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/link-cy/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/link-cy/typescript/_first-request.mdx new file mode 100644 index 0000000000..b84d682041 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/link-cy/typescript/_first-request.mdx @@ -0,0 +1,10 @@ +```typescript index.ts +// Update a rule from card +const updateRuleResponse = linkCy.card.updateRule({ + cardId: "CARDID" + linkcyScaStrategy: "PUSH_NOTIFICATION" + linkcyScaFactor: "BIOMETRY" + type: "TYPE" + value: 0 +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/link-cy/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/link-cy/typescript/_getting-started.mdx new file mode 100644 index 0000000000..8f1f99bb7b --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/link-cy/typescript/_getting-started.mdx @@ -0,0 +1,7 @@ +```typescript index.ts +import { LinkCy } from 'link-cy-typescript-sdk'; + +const linkCy = new LinkCy({ + linkcyAuth: "LINKCY_AUTH" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/link-cy/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/link-cy/typescript/index.tsx new file mode 100644 index 0000000000..5e5f952c40 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/link-cy/typescript/index.tsx @@ -0,0 +1,5900 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function LinkCyTypeScriptSdk() { + return ( + \nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + }, + { + "name": "type", + "schema": "string", + "required": true, + "description": "", + "example": "TYPE" + }, + { + "name": "value", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/card-profiles/{cardProfileId}/rules", + "method": "createDefaultRule", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Card", + "typeScriptTag": "card", + "description": "Create a default card profile rule", + "parameters": [ + { + "name": "cardProfileId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDPROFILEID" + }, + { + "name": "type", + "schema": "string", + "required": true, + "description": "", + "example": "TYPE" + }, + { + "name": "value", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/verifications/phone/verify", + "method": "verifyPhoneVerificationCode", + "httpMethod": HttpMethodsEnum.POST, + "tag": "KYC", + "typeScriptTag": "kyc", + "description": "Verify phone verification code", + "parameters": [ + { + "name": "code", + "schema": "string", + "required": true, + "description": "", + "example": "CODE" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Phone was successfully verified" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/verifications/phone/send", + "method": "sendPhoneVerificationSms", + "httpMethod": HttpMethodsEnum.POST, + "tag": "KYC", + "typeScriptTag": "kyc", + "description": "Send phone verification code by sms", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/verifications/email/send", + "method": "sendEmailVerification", + "httpMethod": HttpMethodsEnum.POST, + "tag": "KYC", + "typeScriptTag": "kyc", + "description": "Send an email verification link by email", + "parameters": [ + { + "name": "emailSubject", + "schema": "string", + "description": "", + "example": "[{partnerName}] Please verify your email" + }, + { + "name": "urlOnSuccess", + "schema": "string", + "description": "", + "example": "https://google.com" + }, + { + "name": "urlOnFailure", + "schema": "string", + "description": "", + "example": "https://google.com" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/verifications/address", + "method": "verifyAddress", + "httpMethod": HttpMethodsEnum.POST, + "tag": "KYC", + "typeScriptTag": "kyc", + "description": "Verify the address of an end-user", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/transactions", + "method": "getAll", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transaction", + "typeScriptTag": "transaction", + "description": "List transactions", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "The id of the end user who is transaction actor (sender / receiver)" + }, + { + "name": "ledgerId", + "schema": "string", + "required": false, + "description": "Get transactions made from or to this ledger (ledgerFrom / ledgerTo)" + }, + { + "name": "cardId", + "schema": "string", + "required": false, + "description": "Get transactions made from this card" + }, + { + "name": "transactionTypes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "paymentTypes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "showReleasedTransaction", + "schema": "boolean", + "required": false, + "description": "Get transactions in RELEASED status (card authorization), by default is true" + }, + { + "name": "showDeclinedTransaction", + "schema": "boolean", + "required": false, + "description": "Get transactions in DECLINED and ABORTED status, by default is true" + }, + { + "name": "startDate", + "schema": "string", + "required": false, + "description": "Get transactions from this date, example: 2022-05-16T10:30" + }, + { + "name": "endDate", + "schema": "string", + "required": false, + "description": "Get transactions until this date, example: 2022-05-16T10:30" + }, + { + "name": "status", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/transactions", + "method": "createBeneficiaryTransaction", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Transaction", + "typeScriptTag": "transaction", + "description": "Create a transaction to a beneficiary", + "parameters": [ + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + }, + { + "name": "amount", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "beneficiaryId", + "schema": "string", + "required": true, + "description": "", + "example": "BENEFICIARYID" + }, + { + "name": "ledgerFromId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERFROMID" + }, + { + "name": "reference", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "allowFastPayment", + "schema": "boolean", + "required": false, + "description": "", + "default": true + }, + { + "name": "allowInterLedger", + "schema": "boolean", + "required": false, + "description": "", + "default": true + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/transactions/inter-ledger", + "method": "createInterLedgerTransaction", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Transaction", + "typeScriptTag": "transaction", + "description": "Create an inter-ledger transaction", + "parameters": [ + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + }, + { + "name": "ledgerFromId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERFROMID" + }, + { + "name": "ledgerToId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERTOID" + }, + { + "name": "amount", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "reference", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/transactions/direct-debit", + "method": "createDirectDebit", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Transaction", + "typeScriptTag": "transaction", + "description": "Create a direct debit transaction", + "parameters": [ + { + "name": "mandateId", + "schema": "string", + "required": true, + "description": "", + "example": "MANDATEID" + }, + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + }, + { + "name": "date", + "schema": "string", + "required": true, + "description": "", + "example": "DATE" + }, + { + "name": "amount", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "reference", + "schema": "string", + "required": true, + "description": "", + "example": "REFERENCE" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/sms", + "method": "sendSms", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Additional", + "typeScriptTag": "additional", + "description": "Send SMS", + "parameters": [ + { + "name": "message", + "schema": "string", + "required": true, + "description": "", + "example": "MESSAGE" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/shares", + "method": "createShare", + "httpMethod": HttpMethodsEnum.POST, + "tag": "KYB", + "typeScriptTag": "kyb", + "description": "Create a share", + "parameters": [ + { + "name": "percentage", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "corporateRelatedId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATERELATEDID" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/sca", + "method": "onboardDeviceSca", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Strong Authentication", + "typeScriptTag": "strongAuthentication", + "description": "Onboard a known mobile.", + "parameters": [ + { + "name": "endpointId", + "schema": "string", + "required": true, + "description": "", + "example": "ENDPOINTID" + }, + { + "name": "factor", + "schema": "string", + "required": false, + "description": "", + "default": "BIOMETRY" + }, + { + "name": "strategy", + "schema": "string", + "required": false, + "description": "", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/sca/qr-codes", + "method": "generateQrCode", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Strong Authentication", + "typeScriptTag": "strongAuthentication", + "description": "Onboard an unknown mobile with QR code", + "parameters": [ + { + "name": "endUserId", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/refresh", + "method": "refreshLogin", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Authentication", + "typeScriptTag": "authentication", + "description": "Log with refresh token", + "parameters": [ + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + }, + { + "name": "refreshToken", + "schema": "string", + "required": true, + "description": "", + "example": "REFRESHTOKEN" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/passwords/reset", + "method": "initializePasswordReset", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Authentication", + "typeScriptTag": "authentication", + "description": "Initialize or reset a password", + "parameters": [ + { + "name": "partnerName", + "schema": "string", + "required": true, + "description": "", + "example": "PARTNERNAME" + }, + { + "name": "phone", + "schema": "string", + "required": true, + "description": "", + "example": "PHONE" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/passwords/reset/sandbox", + "method": "initializePasswordWithSecretInResponse", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Sandbox", + "typeScriptTag": "sandbox", + "description": "Initialize or reset a password with secret in response", + "parameters": [ + { + "name": "partnerName", + "schema": "string", + "required": true, + "description": "", + "example": "PARTNERNAME" + }, + { + "name": "phone", + "schema": "string", + "required": true, + "description": "", + "example": "PHONE" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/passwords/change", + "method": "changeUserPassword", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Authentication", + "typeScriptTag": "authentication", + "description": "Change user password", + "parameters": [ + { + "name": "newPassword", + "schema": "string", + "required": true, + "description": "", + "example": "NEWPASSWORD" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/mandates", + "method": "list", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Direct Debit Mandate", + "typeScriptTag": "directDebitMandate", + "description": "List direct debit mandates", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "The ID of the end user. If empty, the query will return results for all end-users." + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/mandates", + "method": "createNewMandate", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Direct Debit Mandate", + "typeScriptTag": "directDebitMandate", + "description": "Create a new direct debit mandate", + "parameters": [ + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "friendlyName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "debtor", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "recurring", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "expirationDate", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/mandates/{mandateId}/cancel", + "method": "cancelMandate", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Direct Debit Mandate", + "typeScriptTag": "directDebitMandate", + "description": "Cancel a direct debit mandate", + "parameters": [ + { + "name": "mandateId", + "schema": "string", + "required": true, + "description": "", + "example": "MANDATEID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/mandates/{mandateId}/activate", + "method": "activateMandate", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Direct Debit Mandate", + "typeScriptTag": "directDebitMandate", + "description": "Activate a direct debit mandate", + "parameters": [ + { + "name": "mandateId", + "schema": "string", + "required": true, + "description": "", + "example": "MANDATEID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/login", + "method": "userLogin", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Authentication", + "typeScriptTag": "authentication", + "description": "Log into the application", + "parameters": [ + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + }, + { + "name": "password", + "schema": "string", + "required": true, + "description": "", + "example": "PASSWORD" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/ledgers", + "method": "getAll", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Ledger", + "typeScriptTag": "ledger", + "description": "List ledgers", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "The ID of the end user. If empty, the query will return results for all end-users." + }, + { + "name": "status", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "parentId", + "schema": "string", + "required": false, + "description": "The ID of the parent ledger you want to retrieve virtual ledgers from. If empty, the query will return ledgers regardless of parent." + }, + { + "name": "iban", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/ledgers", + "method": "createIban", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Ledger", + "typeScriptTag": "ledger", + "description": "Create a ledger", + "parameters": [ + { + "name": "friendlyName", + "schema": "string", + "description": "" + }, + { + "name": "limits", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/ledgers/{ledgerId}/upgrade", + "method": "upgradeLedger", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Ledger", + "typeScriptTag": "ledger", + "description": "Upgrade a ledger", + "parameters": [ + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/ledgers/{ledgerId}/suspensions", + "method": "suspendLedgerAndCards", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Ledger", + "typeScriptTag": "ledger", + "description": "Suspend a ledger", + "parameters": [ + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + }, + { + "name": "operator", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "reason", + "schema": "string", + "required": true, + "description": "", + "example": "REASON" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/ledgers/{ledgerId}/close", + "method": "closeLedgerAndCards", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Ledger", + "typeScriptTag": "ledger", + "description": "Close a ledger", + "parameters": [ + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + }, + { + "name": "operator", + "schema": "string", + "required": true, + "description": "", + "example": "OPERATOR", + "default": "END_USER" + }, + { + "name": "reason", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/ledgers/credit", + "method": "simulateLedgerCredit", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Sandbox", + "typeScriptTag": "sandbox", + "description": "Credit a ledger", + "parameters": [ + { + "name": "amount", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/kyc", + "method": "listApplications", + "httpMethod": HttpMethodsEnum.GET, + "tag": "KYC", + "typeScriptTag": "kyc", + "description": "List KYC applications", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "personType", + "schema": "string", + "required": false, + "description": "Type of person. If empty, the query will return KYC applications of all people types." + }, + { + "name": "personId", + "schema": "string", + "required": false, + "description": "The ID of the person. If empty, the query will return everyone KYC applications." + }, + { + "name": "kycStatus", + "schema": "string", + "required": false, + "description": "Search KYCs by status. If empty, the query will return KYC applications with any status." + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/kyc", + "method": "requestValidationLink", + "httpMethod": HttpMethodsEnum.POST, + "tag": "KYC", + "typeScriptTag": "kyc", + "description": "Create a KYC for a consumer or a corporate-related person", + "parameters": [ + { + "name": "kycConfiguration", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/kyc/simulate", + "method": "simulateKyc", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Sandbox", + "typeScriptTag": "sandbox", + "description": "Simulate a KYC result for a consumer or a corporate-related person", + "parameters": [ + { + "name": "address", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "kycStatus", + "schema": "string", + "required": true, + "description": "", + "example": "KYCSTATUS" + }, + { + "name": "middleName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "gender", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "birthCity", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "birthIsoCountryCode", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "birthDate", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "nationalityCode", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "firstName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "lastName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "emailAddress", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/end-users/{endUserId}/suspensions", + "method": "suspendCardRuleLinkcy", + "httpMethod": HttpMethodsEnum.POST, + "tag": "End-user", + "typeScriptTag": "endUser", + "description": "Suspend an end-user", + "parameters": [ + { + "name": "endUserId", + "schema": "string", + "required": true, + "description": "", + "example": "ENDUSERID" + }, + { + "name": "operator", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "reason", + "schema": "string", + "required": true, + "description": "", + "example": "REASON" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/documents", + "method": "listForEndUser", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Documents", + "typeScriptTag": "documents", + "description": "List documents", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "type", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/documents", + "method": "uploadForEndUser", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Documents", + "typeScriptTag": "documents", + "description": "Upload a document", + "parameters": [ + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "type", + "schema": "string", + "required": true, + "description": "", + "example": "TYPE" + }, + { + "name": "friendlyName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "file", + "schema": "string", + "required": true, + "description": "", + "example": "FILE" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates", + "method": "listCorporates", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Corporate", + "typeScriptTag": "corporate", + "description": "List your corporates", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "registeredName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "kybStatus", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "bankingStatus", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "suspensionStatus", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "linkcyStatus", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "complianceStatus", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "overallStatus", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates", + "method": "createEndUser", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Corporate", + "typeScriptTag": "corporate", + "description": "Create a corporate", + "parameters": [ + { + "name": "partnerName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "externalId", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "registeredName", + "schema": "string", + "required": true, + "description": "", + "example": "REGISTEREDNAME" + }, + { + "name": "tradeName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "incorporationCountry", + "schema": "string", + "required": true, + "description": "", + "example": "FRA" + }, + { + "name": "incorporationCode", + "schema": "string", + "required": true, + "description": "", + "example": "12345678900013" + }, + { + "name": "incorporationDate", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "legalType", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "website", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "industry", + "schema": "string", + "required": true, + "description": "", + "example": "INDUSTRY" + }, + { + "name": "vatNumber", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "registeredAddress", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "businessAddress", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "expectedMonthlyExpenses", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "employeesRange", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "accountPurposes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "lastTermsAccepted", + "schema": "string", + "required": false, + "description": "", + "example": "1.0" + }, + { + "name": "accountOwnerInfo", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "metadata", + "schema": "object", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates/{corporateId}/related", + "method": "getCorporateRelated", + "httpMethod": HttpMethodsEnum.GET, + "tag": "KYB", + "typeScriptTag": "kyb", + "description": "Get corporate-related entities list", + "parameters": [ + { + "name": "corporateId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATEID" + }, + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "ownedCorporateId", + "schema": "string", + "required": false, + "description": "Parameter to get only the shareholders of this specified corporate-related corporate." + }, + { + "name": "layer", + "schema": "integer", + "required": false, + "description": "Parameter allowing to obtain the associated entities on a specific layer of the corporate." + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates/{corporateId}/related", + "method": "declareCorporateRelatedEntity", + "httpMethod": HttpMethodsEnum.POST, + "tag": "KYB", + "typeScriptTag": "kyb", + "description": "Declare a corporate-related entity (person or corporate)", + "parameters": [ + { + "name": "corporateId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATEID" + }, + { + "name": "info", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "isDirector", + "schema": "boolean", + "required": true, + "description": "", + "example": true + }, + { + "name": "directorAppointmentDate", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sharesInfo", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates/{corporateId}/kyb/verification/ask", + "method": "requestVerification", + "httpMethod": HttpMethodsEnum.POST, + "tag": "KYB", + "typeScriptTag": "kyb", + "description": "Ask a KYB verification", + "parameters": [ + { + "name": "corporateId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATEID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "The KYB verification request was sent successfully" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/consumers", + "method": "listEndUsers", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Consumer", + "typeScriptTag": "consumer", + "description": "List consumers", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "lastName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "phone", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "kycStatus", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "bankingStatus", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "suspensionStatus", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "linkcyStatus", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "complianceStatus", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "overallStatus", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/consumers", + "method": "createIndividualConsumer", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Consumer", + "typeScriptTag": "consumer", + "description": "Create a consumer", + "parameters": [ + { + "name": "partnerName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "firstName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "middleName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "lastName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "externalId", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "phone", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "address", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "emailAddress", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sourceOfFunds", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "otherSourceOfFunds", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "occupation", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "otherOccupation", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "lastTermsAccepted", + "schema": "string", + "required": false, + "description": "", + "example": "1.0" + }, + { + "name": "taxIdentificationNumber", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "taxCountry", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "accountPurposes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "expectedMonthlyExpenses", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "metadata", + "schema": "object", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards", + "method": "listCards", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Card", + "typeScriptTag": "card", + "description": "List cards", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "The ID of the end user. If empty, the query will return results for all end-users." + }, + { + "name": "ledgerId", + "schema": "string", + "required": false, + "description": "The ID of the card ledger. If empty, the query will return cards for all ledgers." + }, + { + "name": "profileId", + "schema": "string", + "required": false, + "description": "The ID of the card profile. If empty, the query will return cards for all profiles." + }, + { + "name": "status", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards", + "method": "createForLedger", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Card", + "typeScriptTag": "card", + "description": "Create a card", + "parameters": [ + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + }, + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + }, + { + "name": "profileId", + "schema": "string", + "required": true, + "description": "", + "example": "PROFILEID" + }, + { + "name": "nameOnCard", + "schema": "string", + "required": false, + "description": "", + "default": "FIRSTNAME LASTNAME" + }, + { + "name": "friendlyName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "rules", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards/{cardId}/suspend", + "method": "suspendCard", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Card", + "typeScriptTag": "card", + "description": "Suspend a card", + "parameters": [ + { + "name": "cardId", + "schema": "string", + "required": true, + "description": "The card id", + "example": "CARDID" + }, + { + "name": "operator", + "schema": "string", + "required": true, + "description": "", + "example": "OPERATOR", + "default": "END_USER" + }, + { + "name": "reason", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "otherReason", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Card is being suspended" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards/{cardId}/pin/reset", + "method": "resetPinAttempts", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Card", + "typeScriptTag": "card", + "description": "Reset physical card's PIN attempts", + "parameters": [ + { + "name": "cardId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDID" + }, + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + } + ], + "responses": [ + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "204", + "description": "Card PIN attempts are being reset" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards/{cardId}/close", + "method": "closeCard", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Card", + "typeScriptTag": "card", + "description": "Close a card", + "parameters": [ + { + "name": "cardId", + "schema": "string", + "required": true, + "description": "The card id", + "example": "CARDID" + }, + { + "name": "operator", + "schema": "string", + "required": true, + "description": "", + "example": "OPERATOR", + "default": "END_USER" + }, + { + "name": "reason", + "schema": "string", + "required": true, + "description": "", + "example": "REASON" + }, + { + "name": "otherReason", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Card is being closed" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards/{cardId}/activate", + "method": "activateCard", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Card", + "typeScriptTag": "card", + "description": "Activate a card", + "parameters": [ + { + "name": "cardId", + "schema": "string", + "required": true, + "description": "The card id", + "example": "CARDID" + }, + { + "name": "truncatedPan", + "schema": "string", + "description": "", + "example": "1111" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Card is being activated" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/card-profiles", + "method": "getProfiles", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Card", + "typeScriptTag": "card", + "description": "List card profiles", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "userTypes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "ledgerTypes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "cardTypes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "active", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/card-profiles", + "method": "createProfileBasedOnDesign", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Card", + "typeScriptTag": "card", + "description": "Create a card profile", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "cardDesignId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDDESIGNID" + }, + { + "name": "active", + "schema": "boolean", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/beneficiaries", + "method": "listAll", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Beneficiary", + "typeScriptTag": "beneficiary", + "description": "List Beneficiaries", + "parameters": [ + { + "name": "active", + "schema": "boolean", + "required": false, + "description": "Show results with only active status or non active status. Both statuses are shown by default." + }, + { + "name": "display", + "schema": "boolean", + "required": false, + "description": "Show only display or non display beneficiaries. Both statuses are shown by default." + }, + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "The ID of the end user. If empty, the query will return results for all end-users." + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/beneficiaries", + "method": "addNew", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Beneficiary", + "typeScriptTag": "beneficiary", + "description": "Add a new beneficiary", + "parameters": [ + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + }, + { + "name": "type", + "schema": "string", + "required": true, + "description": "", + "example": "TYPE" + }, + { + "name": "fullName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "John Michael Doe" + }, + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "bankingDetails", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "display", + "schema": "boolean", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/acquiring/payment", + "method": "initiateTransaction", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Acquiring", + "typeScriptTag": "acquiring", + "description": "Start an acquiring for a payment", + "parameters": [ + { + "name": "amount", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "redirectUrl", + "schema": "string", + "required": true, + "description": "", + "example": "REDIRECTURL" + }, + { + "name": "reference", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/acquiring/account-load", + "method": "initiateTransaction", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Acquiring", + "typeScriptTag": "acquiring", + "description": "Start an acquiring for a top-up", + "parameters": [ + { + "name": "amount", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "targetLedgerId", + "schema": "string", + "required": true, + "description": "", + "example": "TARGETLEDGERID" + }, + { + "name": "redirectUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "reference", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "endUserId", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/accounts", + "method": "listUserAccounts", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Partner", + "typeScriptTag": "partner", + "description": "List user accounts", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/accounts", + "method": "createUserAccount", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Partner", + "typeScriptTag": "partner", + "description": "Create user account", + "parameters": [], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner", + "method": "getConfiguration", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Partner", + "typeScriptTag": "partner", + "description": "Get your information", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "Your information as Partner." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner", + "method": "updateConfiguration", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Partner", + "typeScriptTag": "partner", + "description": "Update your information", + "parameters": [ + { + "name": "address", + "schema": "object", + "description": "" + }, + { + "name": "consumerOtpMessage", + "schema": "string", + "description": "" + }, + { + "name": "corporateOtpMessage", + "schema": "string", + "description": "" + }, + { + "name": "displayName", + "schema": "string", + "description": "" + }, + { + "name": "logoUrl", + "schema": "string", + "description": "" + }, + { + "name": "contactInformation", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/shares/{shareId}", + "method": "deleteShare", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "KYB", + "typeScriptTag": "kyb", + "description": "Delete a share", + "parameters": [ + { + "name": "shareId", + "schema": "string", + "required": true, + "description": "", + "example": "SHAREID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/shares/{shareId}", + "method": "getShareInformation", + "httpMethod": HttpMethodsEnum.GET, + "tag": "KYB", + "typeScriptTag": "kyb", + "description": "Get share's information", + "parameters": [ + { + "name": "shareId", + "schema": "string", + "required": true, + "description": "", + "example": "SHAREID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/shares/{shareId}", + "method": "updateShareInformation", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "KYB", + "typeScriptTag": "kyb", + "description": "Update a share", + "parameters": [ + { + "name": "shareId", + "schema": "string", + "required": true, + "description": "", + "example": "SHAREID" + }, + { + "name": "percentage", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/sca/{scaDeviceId}", + "method": "resetUserDeviceSca", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Strong Authentication", + "typeScriptTag": "strongAuthentication", + "description": "Reset the SCA device of a user", + "parameters": [ + { + "name": "scaDeviceId", + "schema": "string", + "required": true, + "description": "", + "example": "SCADEVICEID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/sca/{scaDeviceId}", + "method": "updateFactor", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Strong Authentication", + "typeScriptTag": "strongAuthentication", + "description": "Add an authentication Factor", + "parameters": [ + { + "name": "scaDeviceId", + "schema": "string", + "required": true, + "description": "", + "example": "SCADEVICEID" + }, + { + "name": "factor", + "schema": "string", + "required": true, + "description": "", + "example": "FACTOR" + }, + { + "name": "strategy", + "schema": "string", + "required": false, + "description": "", + "default": "PUSH_NOTIFICATION" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/mandates/{mandateId}", + "method": "getInformation", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Direct Debit Mandate", + "typeScriptTag": "directDebitMandate", + "description": "Get a direct debit mandate information", + "parameters": [ + { + "name": "mandateId", + "schema": "string", + "required": true, + "description": "", + "example": "MANDATEID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/mandates/{mandateId}", + "method": "updateMandate", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Direct Debit Mandate", + "typeScriptTag": "directDebitMandate", + "description": "Update a direct debit mandate", + "parameters": [ + { + "name": "mandateId", + "schema": "string", + "required": true, + "description": "", + "example": "MANDATEID" + }, + { + "name": "friendlyName", + "schema": "string", + "description": "" + }, + { + "name": "debtor", + "schema": "object", + "description": "" + }, + { + "name": "recurring", + "schema": "boolean", + "description": "" + }, + { + "name": "expirationDate", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/ledgers/{ledgerId}", + "method": "getInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Ledger", + "typeScriptTag": "ledger", + "description": "Get information on a ledger", + "parameters": [ + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/ledgers/{ledgerId}", + "method": "updateInformation", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Ledger", + "typeScriptTag": "ledger", + "description": "Update a ledger", + "parameters": [ + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + }, + { + "name": "friendlyName", + "schema": "string", + "description": "" + }, + { + "name": "parentLedgerId", + "schema": "string", + "description": "" + }, + { + "name": "limits", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates/{corporateId}", + "method": "deleteCorporateById", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Sandbox", + "typeScriptTag": "sandbox", + "description": "Delete a corporate", + "parameters": [ + { + "name": "corporateId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATEID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "OK" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates/{corporateId}", + "method": "getInformation", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Corporate", + "typeScriptTag": "corporate", + "description": "Get corporate's information", + "parameters": [ + { + "name": "corporateId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATEID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "The complete corporate information." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates/{corporateId}", + "method": "updateInformation", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Corporate", + "typeScriptTag": "corporate", + "description": "Update a corporate", + "parameters": [ + { + "name": "corporateId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATEID" + }, + { + "name": "externalId", + "schema": "string", + "description": "" + }, + { + "name": "registeredName", + "schema": "string", + "description": "" + }, + { + "name": "tradeName", + "schema": "string", + "description": "" + }, + { + "name": "incorporationCountry", + "schema": "string", + "description": "", + "example": "FRA" + }, + { + "name": "incorporationCode", + "schema": "string", + "description": "", + "example": "12345678900013" + }, + { + "name": "incorporationDate", + "schema": "string", + "description": "" + }, + { + "name": "legalType", + "schema": "object", + "description": "" + }, + { + "name": "website", + "schema": "string", + "description": "" + }, + { + "name": "industry", + "schema": "string", + "description": "" + }, + { + "name": "vatNumber", + "schema": "string", + "description": "" + }, + { + "name": "registeredAddress", + "schema": "object", + "description": "" + }, + { + "name": "businessAddress", + "schema": "object", + "description": "" + }, + { + "name": "expectedMonthlyExpenses", + "schema": "object", + "description": "" + }, + { + "name": "employeesRange", + "schema": "string", + "description": "" + }, + { + "name": "accountPurposes", + "schema": "array", + "description": "" + }, + { + "name": "lastTermsAccepted", + "schema": "string", + "description": "", + "example": "1.0" + }, + { + "name": "metadata", + "schema": "object", + "description": "" + }, + { + "name": "userMetadata", + "schema": "object", + "description": "" + }, + { + "name": "partnerMetadata", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates/{corporateId}/related/{corporateRelatedId}", + "method": "getCorporateRelatedInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "KYB", + "typeScriptTag": "kyb", + "description": "Get corporate-related entity's information", + "parameters": [ + { + "name": "corporateId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATEID" + }, + { + "name": "corporateRelatedId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATERELATEDID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Information about this corporate-related entity." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates/{corporateId}/related/{corporateRelatedId}", + "method": "updateCorporateRelatedEntity", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "KYB", + "typeScriptTag": "kyb", + "description": "Update a corporate-related entity (person or corporate)", + "parameters": [ + { + "name": "corporateId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATEID" + }, + { + "name": "corporateRelatedId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATERELATEDID" + }, + { + "name": "externalId", + "schema": "string", + "description": "" + }, + { + "name": "isDirector", + "schema": "boolean", + "description": "" + }, + { + "name": "directorAppointmentDate", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/corporates/{corporateId}/kyb", + "method": "bypassKycStatus", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Sandbox", + "typeScriptTag": "sandbox", + "description": "Manually bypass a corporate's KYB status", + "parameters": [ + { + "name": "corporateId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATEID" + }, + { + "name": "kybStatus", + "schema": "string", + "required": true, + "description": "", + "example": "KYBSTATUS" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/consumers/{consumerId}", + "method": "deleteConsumerById", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Sandbox", + "typeScriptTag": "sandbox", + "description": "Delete a consumer", + "parameters": [ + { + "name": "consumerId", + "schema": "string", + "required": true, + "description": "", + "example": "CONSUMERID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "OK" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/consumers/{consumerId}", + "method": "getInformation", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Consumer", + "typeScriptTag": "consumer", + "description": "Get consumer's information", + "parameters": [ + { + "name": "consumerId", + "schema": "string", + "required": true, + "description": "", + "example": "CONSUMERID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "The complete consumer information." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/consumers/{consumerId}", + "method": "updateInformation", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Consumer", + "typeScriptTag": "consumer", + "description": "Update a consumer", + "parameters": [ + { + "name": "consumerId", + "schema": "string", + "required": true, + "description": "", + "example": "CONSUMERID" + }, + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + }, + { + "name": "externalId", + "schema": "string", + "description": "" + }, + { + "name": "address", + "schema": "object", + "description": "" + }, + { + "name": "emailAddress", + "schema": "string", + "description": "" + }, + { + "name": "sourceOfFunds", + "schema": "string", + "description": "" + }, + { + "name": "otherSourceOfFunds", + "schema": "string", + "description": "" + }, + { + "name": "occupation", + "schema": "string", + "description": "" + }, + { + "name": "otherOccupation", + "schema": "string", + "description": "" + }, + { + "name": "lastTermsAccepted", + "schema": "string", + "description": "", + "example": "1.0" + }, + { + "name": "taxIdentificationNumber", + "schema": "string", + "description": "" + }, + { + "name": "taxCountry", + "schema": "string", + "description": "" + }, + { + "name": "accountPurposes", + "schema": "array", + "description": "" + }, + { + "name": "expectedMonthlyExpenses", + "schema": "object", + "description": "" + }, + { + "name": "phone", + "schema": "object", + "description": "" + }, + { + "name": "metadata", + "schema": "object", + "description": "" + }, + { + "name": "userMetadata", + "schema": "object", + "description": "" + }, + { + "name": "partnerMetadata", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards/{cardId}", + "method": "getInformation", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Card", + "typeScriptTag": "card", + "description": "Get card's information", + "parameters": [ + { + "name": "cardId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "The complete card information" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards/{cardId}", + "method": "updateInformation", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Card", + "typeScriptTag": "card", + "description": "Update a card", + "parameters": [ + { + "name": "cardId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDID" + }, + { + "name": "friendlyName", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/card-profiles/{cardProfileId}", + "method": "updateProfile", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Card", + "typeScriptTag": "card", + "description": "Update a card profile", + "parameters": [ + { + "name": "cardProfileId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDPROFILEID" + }, + { + "name": "active", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/beneficiaries/{beneficiaryId}", + "method": "getInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Beneficiary", + "typeScriptTag": "beneficiary", + "description": "Get beneficiary's information", + "parameters": [ + { + "name": "beneficiaryId", + "schema": "string", + "required": true, + "description": "", + "example": "BENEFICIARYID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/beneficiaries/{beneficiaryId}", + "method": "updateDetails", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Beneficiary", + "typeScriptTag": "beneficiary", + "description": "Patch a beneficiary", + "parameters": [ + { + "name": "beneficiaryId", + "schema": "string", + "required": true, + "description": "", + "example": "BENEFICIARYID" + }, + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + }, + { + "name": "active", + "schema": "boolean", + "description": "" + }, + { + "name": "display", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/beneficiaries/{beneficiaryId}/status", + "method": "bypassBeneficiaryStatus", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Sandbox", + "typeScriptTag": "sandbox", + "description": "Bypass a beneficiary's status", + "parameters": [ + { + "name": "beneficiaryId", + "schema": "string", + "required": true, + "description": "", + "example": "BENEFICIARYID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/accounts/{accountId}", + "method": "updateUserAccount", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "Partner", + "typeScriptTag": "partner", + "description": "Update user account", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "", + "example": "ACCOUNTID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/webhooks", + "method": "portalUrlGet", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Webhook", + "typeScriptTag": "webhook", + "description": "Get your webhook portal url", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/web-page/{pageId}", + "method": "getHtmlPage", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Web Pages", + "typeScriptTag": "webPages", + "description": "Retrieve the web html page corresponding to a previous operation.", + "parameters": [ + { + "name": "pageId", + "schema": "string", + "required": true, + "description": "", + "example": "PAGEID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/transactions/{transactionId}", + "method": "getInformation", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transaction", + "typeScriptTag": "transaction", + "description": "Get transaction's information", + "parameters": [ + { + "name": "transactionId", + "schema": "string", + "required": true, + "description": "", + "example": "TRANSACTIONID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/kyc/{kycId}", + "method": "getApplication", + "httpMethod": HttpMethodsEnum.GET, + "tag": "KYC", + "typeScriptTag": "kyc", + "description": "Get kyc application", + "parameters": [ + { + "name": "kycId", + "schema": "string", + "required": true, + "description": "", + "example": "KYCID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/documents/{documentId}", + "method": "getDownloadLink", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Documents", + "typeScriptTag": "documents", + "description": "Get a document", + "parameters": [ + { + "name": "documentId", + "schema": "string", + "required": true, + "description": "", + "example": "DOCUMENTID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/documents/ledger-statement/{ledgerId}", + "method": "getStatementById", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Ledger", + "typeScriptTag": "ledger", + "description": "Get a ledger statement", + "parameters": [ + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + }, + { + "name": "startDate", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "endDate", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Response including url link and time to leave Duration." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/documents/diligence-review/{corporateId}", + "method": "getDiligenceReview", + "httpMethod": HttpMethodsEnum.GET, + "tag": "KYB", + "typeScriptTag": "kyb", + "description": "Get diligence review of a corporate", + "parameters": [ + { + "name": "corporateId", + "schema": "string", + "required": true, + "description": "", + "example": "CORPORATEID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Response including url link and time to leave Duration." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/documents/bank-details/{ledgerId}", + "method": "getBankingDetails", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Ledger", + "typeScriptTag": "ledger", + "description": "Get banking details from ledger", + "parameters": [ + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Response including url link and time to leave Duration." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/docs/terms", + "method": "getTermsAndConditions", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Additional", + "typeScriptTag": "additional", + "description": "Get terms and conditions", + "parameters": [ + { + "name": "termsAndConditionsInfoRequestDto", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Terms and conditions information." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards/{cardId}/pin", + "method": "getPin", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Card", + "typeScriptTag": "card", + "description": "Get a physical card's PIN", + "parameters": [ + { + "name": "cardId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDID" + }, + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards/{cardId}/pan", + "method": "getTruncatedPan", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Sandbox", + "typeScriptTag": "sandbox", + "description": "Get a card truncated PAN", + "parameters": [ + { + "name": "cardId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards/{cardId}/pan/credentials", + "method": "getPanCredentials", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Card", + "typeScriptTag": "card", + "description": "Get PAN credentials", + "parameters": [ + { + "name": "cardId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDID" + }, + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "409", + "description": "" + } + ] + }, + { + "url": "/api/partner/card-designs", + "method": "getDesigns", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Card", + "typeScriptTag": "card", + "description": "List card designs", + "parameters": [ + { + "name": "sortAttribute", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "scheme", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "ledgerType", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "cardType", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "userType", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "pageSize", + "schema": "integer", + "required": false, + "description": "The size of the page to be returned." + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number." + }, + { + "name": "sortDirection", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/acquiring/transactions/{transactionId}", + "method": "transactionInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Acquiring", + "typeScriptTag": "acquiring", + "description": "Get acquiring transaction information", + "parameters": [ + { + "name": "transactionId", + "schema": "string", + "required": true, + "description": "", + "example": "TRANSACTIONID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/acquiring-configuration", + "method": "acquiringConfigurationGet", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Partner", + "typeScriptTag": "partner", + "description": "Get your acquiring configuration", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/ledgers/{ledgerId}/suspensions/{operator}", + "method": "unsuspendLedger", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Ledger", + "typeScriptTag": "ledger", + "description": "Unsuspend a ledger", + "parameters": [ + { + "name": "ledgerId", + "schema": "string", + "required": true, + "description": "", + "example": "LEDGERID" + }, + { + "name": "operator", + "schema": "string", + "required": true, + "description": "", + "example": "OPERATOR" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/end-users/{endUserId}/suspensions/{operator}", + "method": "unsuspendById", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "End-user", + "typeScriptTag": "endUser", + "description": "Unsuspend an end-user", + "parameters": [ + { + "name": "endUserId", + "schema": "string", + "required": true, + "description": "", + "example": "ENDUSERID" + }, + { + "name": "operator", + "schema": "string", + "required": true, + "description": "", + "example": "OPERATOR" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + } + ] + }, + { + "url": "/api/partner/cards/{cardId}/rules/{ruleType}", + "method": "removeRule", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Card", + "typeScriptTag": "card", + "description": "Remove card rule", + "parameters": [ + { + "name": "cardId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDID" + }, + { + "name": "ruleType", + "schema": "string", + "required": true, + "description": "", + "example": "RULETYPE" + }, + { + "name": "linkcyScaStrategy", + "schema": "string", + "required": false, + "description": "The strategy to use when a SCA is required:\n
\nMore information:\n\n- `PUSH_NOTIFICATION`: will send a notification if the SCA is required.\n- `JOIN_CODE`: will return a join code if SCA is required.\n- `FAIL`: will fail if SCA is required.\n- `BY_PASS`: Sandbox only - will ignore any SCA if used.\n
\n\n\n
\nErrorCode\n\n- 409 Conflict\n - `SCA_REQUIRED`: The operation requires SCA. Can be returned if you try to use BY_PASS while not allowed. Will be returned if strategy is FAIL.\n - `SCA_DEVICE_NOT_SET`: The operation requires SCA and strategy allows it, but the user has no sca device set up. You need to enroll one first. \n
", + "default": "PUSH_NOTIFICATION" + }, + { + "name": "linkcyScaFactor", + "schema": "string", + "required": false, + "description": "The factor type required for the operation :\n
\nMore information:\n\n- `BIOMETRY`: will require fingerprint or face recognition depending on device.\n- `PIN`: will require the endpoint pin. When using this factor, a pin must have been registered through the SDK first. Sca pin and end user password can differ.\n
\n\n
\nErrorCode\n\n- 400 Bad Request\n - `SCA_FACTOR_NOT_SET`: The user has a sca device set up, but the factor requested is not enrolled yet. You must either enroll it or change the factor.\n
\n", + "default": "BIOMETRY" + }, + { + "name": "linkcyScaId", + "schema": "string", + "required": false, + "description": "The id of the completed SCA operation.\n\n
\nErrorCode\n\n- 404 Not Found\n - `SCA_INTERACTION_NOT_FOUND`: The specified id could not be found.\n- 409 Conflict\n - `SCA_INTERACTION_NOT_COMPLETED`: The SCA interaction is not completed (https://docs.sandbox.linkcy.io/.\n - `SCA_INTERACTION_DECLINED`: The SCA interaction was declined by user or expired. \n - `SCA_INTERACTION_ALREADY_CONSUMED`: The SCA interaction has already been used, you need to create a new one.\n - `SCA_INTERACTION_DOES_NOT_MATCH`: The SCA interaction does not match the one you are trying to make. Body or url is different.\n
" + } + ], + "responses": [ + { + "statusCode": "202", + "description": "" + }, + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/api/partner/card-profiles/{cardProfileId}/rules/{ruleType}", + "method": "removeDefaultRule", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Card", + "typeScriptTag": "card", + "description": "Remove default card profile rule", + "parameters": [ + { + "name": "cardProfileId", + "schema": "string", + "required": true, + "description": "", + "example": "CARDPROFILEID" + }, + { + "name": "ruleType", + "schema": "string", + "required": true, + "description": "", + "example": "RULETYPE" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "No Content" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + } +] + } + language="TypeScript" + apiTitle="Linkcy Api" + apiBaseUrl="https://api.sandbox.linkcy.cloud" + apiVersion="1.78.0" + endpoints={125} + sdkMethods={102} + schemas={699} + parameters={410} + difficulty="Hard" + openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/linkcy/openapi.yaml" + openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/linkcy/openapi.yaml" + developerDocumentation="docs.sandbox.linkcy.io/" + /> + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/monto/index.tsx b/generator/konfig-docs/src/pages/sdk/monto/index.tsx new file mode 100644 index 0000000000..416ed830a0 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/monto/index.tsx @@ -0,0 +1,73 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Monto", + "numberOfMethods": 37, + "categories": [ + "fintech", + "financial_data", + "lending", + "credit_decisions" + ], + "index": "monto/typescript", + "language": "TypeScript", + "link": "/sdk/monto/typescript/", + "developerDocumentation": "monto.redoc.ly/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/monto/openapi.yaml" + }, + { + "name": "Monto", + "numberOfMethods": 37, + "categories": [ + "fintech", + "financial_data", + "lending", + "credit_decisions" + ], + "index": "monto/python", + "language": "Python", + "link": "/sdk/monto/python/", + "developerDocumentation": "monto.redoc.ly/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/monto/openapi.yaml" + }, + { + "name": "Monto", + "numberOfMethods": 37, + "categories": [ + "fintech", + "financial_data", + "lending", + "credit_decisions" + ], + "index": "monto/java", + "language": "Java", + "link": "/sdk/monto/java/", + "developerDocumentation": "monto.redoc.ly/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/monto/openapi.yaml" + } +]; + +export default function Monto() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/monto/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/monto/typescript/_first-request.mdx new file mode 100644 index 0000000000..0f3a958001 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/monto/typescript/_first-request.mdx @@ -0,0 +1,4 @@ +```typescript index.ts +// Get integrations +const listSupportedResponse = monto.integration.listSupported() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/monto/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/monto/typescript/_getting-started.mdx new file mode 100644 index 0000000000..690fc12fbc --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/monto/typescript/_getting-started.mdx @@ -0,0 +1,8 @@ +```typescript index.ts +import { Monto } from 'monto-typescript-sdk'; + +const monto = new Monto({ + // The word "Basic" followed by a space and your API Key as base64encoded. Contact support@monto.ai to obtain an API key. + apiKeyAuth: "AUTHORIZATION" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/monto/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/monto/typescript/index.tsx new file mode 100644 index 0000000000..ff07f96124 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/monto/typescript/index.tsx @@ -0,0 +1,1484 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function MontoTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/sdk-links.json b/generator/konfig-docs/src/pages/sdk/sdk-links.json index 27ce057667..11f947dc4f 100644 --- a/generator/konfig-docs/src/pages/sdk/sdk-links.json +++ b/generator/konfig-docs/src/pages/sdk/sdk-links.json @@ -1979,6 +1979,20 @@ "subCategory": "CRM (Customer Relationship Management)", "apiVersion": "v3" }, + { + "index": "hypatos/typescript", + "link": "/sdk/hypatos/typescript/", + "homepage": "hypatos.ai", + "categories": [ + "machine_learning", + "ai", + "document_processing" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/hypatos/favicon.png", + "parentCategory": "Artificial Intelligence", + "subCategory": "AI Tools", + "apiVersion": "2.13.0" + }, { "index": "hyperplane/typescript", "link": "/sdk/hyperplane/typescript/", @@ -2394,6 +2408,22 @@ "subCategory": "eCommerce", "apiVersion": "" }, + { + "index": "link-cy/typescript", + "link": "/sdk/link-cy/typescript/", + "homepage": "linkcy.io", + "categories": [ + "fintech", + "banking", + "financial_technology", + "banking_as_a_service", + "white_label_banking" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/linkcy/favicon.png", + "parentCategory": "Data", + "subCategory": "Finance", + "apiVersion": "1.78.0" + }, { "index": "lob/typescript", "link": "/sdk/lob/typescript/", @@ -2614,6 +2644,21 @@ "subCategory": "Gaming", "apiVersion": "v2.7.0/15cf3fc" }, + { + "index": "monto/typescript", + "link": "/sdk/monto/typescript/", + "homepage": "monto.ai", + "categories": [ + "fintech", + "financial_data", + "lending", + "credit_decisions" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/monto/favicon.png", + "parentCategory": "Data", + "subCategory": "Finance", + "apiVersion": "v1" + }, { "index": "multiwoven/typescript", "link": "/sdk/multiwoven/typescript/", @@ -3847,6 +3892,19 @@ "subCategory": "Social Media Marketing", "apiVersion": "3.0.0" }, + { + "index": "token/typescript", + "link": "/sdk/token/typescript/", + "homepage": "token.io", + "categories": [ + "open_banking", + "payments" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/token/favicon.png", + "parentCategory": "Commerce", + "subCategory": "Payment Processing", + "apiVersion": "v1.2.3.2" + }, { "index": "tramit-app/typescript", "link": "/sdk/tramit-app/typescript/", @@ -3908,6 +3966,19 @@ "subCategory": "AI Tools", "apiVersion": "1.8.0" }, + { + "index": "edge/typescript", + "link": "/sdk/edge/typescript/", + "homepage": "tryedge.io", + "categories": [ + "online_payments", + "financial_data_management" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/edge/favicon.png", + "parentCategory": "Commerce", + "subCategory": "Payment Processing", + "apiVersion": "v1" + }, { "index": "rook/typescript", "link": "/sdk/rook/typescript/", diff --git a/generator/konfig-docs/src/pages/sdk/token/index.tsx b/generator/konfig-docs/src/pages/sdk/token/index.tsx new file mode 100644 index 0000000000..62946af15a --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/token/index.tsx @@ -0,0 +1,85 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Token", + "numberOfMethods": 63, + "categories": [ + "open_banking", + "payments" + ], + "index": "token/typescript", + "language": "TypeScript", + "link": "/sdk/token/typescript/", + "developerDocumentation": "reference.token.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/token/openapi.yaml" + }, + { + "name": "Token", + "numberOfMethods": 63, + "categories": [ + "open_banking", + "payments" + ], + "index": "token/python", + "language": "Python", + "link": "/sdk/token/python/", + "developerDocumentation": "reference.token.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/token/openapi.yaml" + }, + { + "name": "Token", + "numberOfMethods": 63, + "categories": [ + "open_banking", + "payments" + ], + "index": "token/java", + "language": "Java", + "link": "/sdk/token/java/", + "developerDocumentation": "reference.token.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/token/openapi.yaml" + } +]; + +export default function Token() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/token/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/token/typescript/_first-request.mdx new file mode 100644 index 0000000000..e1785ec2a8 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/token/typescript/_first-request.mdx @@ -0,0 +1,6 @@ +```typescript index.ts +// Get information for all accounts +const getAllAccountsResponse = token.accounts.getAllAccounts({ + tokenCustomerIpAddress: "172.16.254.1" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/token/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/token/typescript/_getting-started.mdx new file mode 100644 index 0000000000..acc4a636cf --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/token/typescript/_getting-started.mdx @@ -0,0 +1,10 @@ +```typescript index.ts +import { Token } from 'token-typescript-sdk'; + +const token = new Token({ + // When using curl samples the authorization header is given as -H `'Authorization: YOUR_API_KEY_HERE'`
Please substitute your Basic key here.
For example:
-H `'Authorization: Basic bS0zanhoS3pqRjRSWFQ1dHZLTlhMQU14cm80d0E1LTV6S3RYRUFxOmU1MWZjZDQ0LTM5MGQtNDYxZi04YjA0LTEyMjcxOTg4YWYwNg=='` + basicAuth: "AUTHORIZATION", + // When using curl samples the authorization header is given as -H `'Authorization: YOUR_API_KEY_HERE'`
Please substitute your Bearer key here.
For example:
-H `'Authorization: Bearer eyJhbGciOiJFZERTQSIsImtpZCI6IjF4N2RmNHZ1RlVIWVFDYTciLCJtaWQiOiJtOlhUalhlMkFQZTRvdmVaalE4cHoyNGdEbUZEcTo1ekt0WEVBcSIsImhvc3QiOiJsb2NhbGhvc3Q6ODAwMCIsIm1ldGhvZCI6IlBPU1QiLCJwYXRoIjoiL2JhbmtzL2lyb24vdXNlcnMiLCJleHAiOjE1ODYyOTczNDQ3ODd9..bi3wxEoMHIul_F2f7gCDvgjHQKCjIyP9_SkQns-yXpS0UqoaOqSJrW89COexU71gt-mH3jH6mtp2aksEywvFDg'`
Enter the JWT Bearer token only (see Using JWT Authentication for more information). + bearer: "BEARER" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/token/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/token/typescript/index.tsx new file mode 100644 index 0000000000..345178177a --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/token/typescript/index.tsx @@ -0,0 +1,4974 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function TokenTypeScriptSdk() { + return ( + i.e., the request is user-initiated; adding a `customer-initiated` = `true` header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.", + "example": "172.16.254.1" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Each object represents a unique bank account." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/accounts/{accountId}", + "method": "getInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Get account information", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The system-generated, unique bank account id, which specifies the account for which the information is requested.", + "example": "a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV" + }, + { + "name": "tokenCustomerIpAddress", + "schema": "string", + "required": false, + "description": "The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (https://reference.token.io/, it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a `customer-initiated` = `true` header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.", + "example": "172.16.254.1" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Operation completed successfully." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/account-balance", + "method": "getMultipleBalances", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Get account balances", + "parameters": [ + { + "name": "tokenCustomerIpAddress", + "schema": "string", + "required": false, + "description": "The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (https://reference.token.io/, it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a `customer-initiated` = `true` header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.", + "example": "172.16.254.1" + }, + { + "name": "accountId", + "schema": "array", + "required": false, + "description": "A comma-separated list of account ids for which you wish to retrieve account balances.", + "example": [ + "a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV", + "a:9TFpwkcQmcsMbdjQcpdjfsEBosDw28503fAAGPEMF2MVF19hfk3nc", + "a:rtmv254gaskGLdkadQvdNesk2Y9ferbvpaom5mvepm0mv2nfGnaix" + ] + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/accounts/{accountId}/balance", + "method": "getBalance", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Get an account balance", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The unique bank account id, which specifies the account for which the information is requested.", + "example": "ACCOUNTID" + }, + { + "name": "tokenCustomerIpAddress", + "schema": "string", + "required": false, + "description": "The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (https://reference.token.io/, it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a `customer-initiated` = `true` header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.", + "example": "172.16.254.1" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/accounts/{accountId}/standing-orders", + "method": "getStandingOrders", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Get information for all standing orders", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The unique bank account id, which specifies the account for which the information is requested.", + "example": "ACCOUNTID" + }, + { + "name": "pageOffset", + "schema": "string", + "required": false, + "description": "The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data.
The offset is not visible to a user and should not be parsed and/or understood in any way.", + "example": "LerV6Jmex" + }, + { + "name": "pageLimit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return. This must be less than 200.", + "example": 175, + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/accounts/{accountId}/standing-orders/{standingOrderId}", + "method": "getStandingOrder", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Get standing order information", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The system-generated, unique bank account id, which specifies the account for which the information is requested.", + "example": "a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV" + }, + { + "name": "standingOrderId", + "schema": "string", + "required": true, + "description": "", + "example": "STANDINGORDERID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/accounts/{accountId}/transactions", + "method": "getTransactions", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Get account transactions", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The system-generated unique bank account id, which specifies the account for which the information is requested.", + "example": "a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV" + }, + { + "name": "tokenCustomerIpAddress", + "schema": "string", + "required": false, + "description": "The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (https://reference.token.io/, it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a `customer-initiated` = `true` header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.", + "example": "172.16.254.1" + }, + { + "name": "pageOffset", + "schema": "string", + "required": false, + "description": "The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data.
The offset is not visible to a user and should not be parsed and/or understood in any way.", + "example": "LerV6Jmex" + }, + { + "name": "pageLimit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return. This must be less than 200.", + "example": 175, + "default": 1 + }, + { + "name": "startDate", + "schema": "string", + "required": false, + "description": "The earliest transaction date requested, in ISO 8601 format.", + "example": "2022-06-15" + }, + { + "name": "endDate", + "schema": "string", + "required": false, + "description": "The latest transaction date requested, in ISO 8601 format.", + "example": "2022-11-30" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/accounts/{accountId}/transaction/{transactionId}", + "method": "getTransactionDetails", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Get transaction information", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The unique bank account id, which specifies the account for which the information is requested.", + "example": "ACCOUNTID" + }, + { + "name": "transactionId", + "schema": "string", + "required": true, + "description": "The unique transaction identifier, which specifies the transaction requested.", + "example": "42909b155d4942299c39017686b5dc36" + }, + { + "name": "tokenCustomerIpAddress", + "schema": "string", + "required": false, + "description": "The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (https://reference.token.io/, it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a `customer-initiated` = `true` header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.", + "example": "172.16.254.1" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/accounts/{accountId}/funds-confirmation", + "method": "confirmFundsAvailability", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Confirm available funds", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The system-generated, unique bank account id, which specifies the account for which the information is requested.", + "example": "a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV" + }, + { + "name": "amount", + "schema": "undefined", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "A flag indicating whether funds are available or not. If set to `true`, funds are available for transfer." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/banks", + "method": "getList", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Banks v1", + "typeScriptTag": "banksV1", + "description": "Get banks v1", + "parameters": [ + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The index of the page currently being retrieved.", + "example": 1 + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "The number of records per page.", + "example": 175 + }, + { + "name": "sort", + "schema": "string", + "required": false, + "description": "The key to sort the result. This can be `name` (i.e., bank name), `provider`, or `country`.", + "example": "country", + "default": "name" + }, + { + "name": "memberId", + "schema": "string", + "required": false, + "description": "The Token.io-assigned member id of the TPP.", + "example": "m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq" + }, + { + "name": "ids", + "schema": "array", + "required": false, + "description": "Filters for banks with a `bankId` (https://reference.token.io/ matching any of the ids listed, up to a maximum of 1000. Only exact (full string) matches are returned.", + "example": [ + "goldbank", + "opalbank", + "platinumbank" + ] + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "Filters for banks with a name or identifiers containing this search string.", + "example": "hsbc" + }, + { + "name": "tppId", + "schema": "string", + "required": false, + "description": "Filters for banks for which the TPP represented by this `tppId` has access.", + "example": "4h27g823-g73s-07v3-l49s-prte94bf21v" + }, + { + "name": "providers", + "schema": "array", + "required": false, + "description": "Filters for banks that are accessed through any of the listed providers.", + "example": "Token.io" + }, + { + "name": "bankCode", + "schema": "string", + "required": false, + "description": "Filters for banks with a BIC (or BLZ, if German) that matches this `bankCode`. The BIC must have a string length of 8 or 11. The BLZ must have a string length of 8.", + "example": "NBAGDE3E" + }, + { + "name": "countries", + "schema": "array", + "required": false, + "description": "Filters for banks that are located in the countries specified by this list of ISO 3166-1 Alpha 2 country codes, in upper case.", + "example": [ + "IT", + "DE", + "RO" + ] + }, + { + "name": "bankFeaturesSupportsSendPaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support payment initiation.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsReceivePaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support receiving payments.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsBalanceValue", + "schema": "boolean", + "required": false, + "description": "Filters for the banks that support retrieving balances", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsScheduledPaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support future dated scheduled payments.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsStandingOrderValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support recurring payments/standing orders.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesRequiresOneStepPaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that only support immediate redemption of transfers.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsFundsConfirmationValue", + "schema": "boolean", + "required": false, + "description": "Filters for the banks that support confirmation of available funds.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsReturnRefundAccountValue", + "schema": "boolean", + "required": false, + "description": "Filters for the banks that support request of refund account.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsTransactionsDateFilterValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support retrieving transactions by date filter.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsAccountInformationValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support retrieval of account information.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsSinglePaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support single immediate payments.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsVariableRecurringPaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support variable recurring payments.", + "example": false, + "default": false + }, + { + "name": "bics", + "schema": "array", + "required": false, + "description": "Filters for banks whose BIC matches any of the listed BICs (https://reference.token.io/, up to a maximum of 1000." + }, + { + "name": "supportedPaymentNetworks", + "schema": "array", + "required": false, + "description": "Filters for banks that support any of the listed payment networks." + }, + { + "name": "bankGroup", + "schema": "string", + "required": false, + "description": "Filters for banks that are part of the bank group specified.", + "example": [ + "HSBC", + "Coop" + ] + }, + { + "name": "bankSubGroup", + "schema": "string", + "required": false, + "description": "Filters for banks that are part of the bank sub-group specified.", + "example": [ + "CMM Grand", + "Banque Populaire", + "La Banque" + ] + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/bank/countries", + "method": "getBankCountries", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Banks v1", + "typeScriptTag": "banksV1", + "description": "Get bank countries", + "parameters": [ + { + "name": "ids", + "schema": "array", + "required": false, + "description": "Filters for banks with bank ids that are represented in this list of ids (https://reference.token.io/, up to a maximum of 1000.", + "example": [ + "goldbank", + "opalbank", + "platinumbank" + ] + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "Filters for banks with names or identifiers that contain this search string (case sensitive).", + "example": "banca" + }, + { + "name": "tppId", + "schema": "string", + "required": false, + "description": "Filters for banks to which the TPP with this `tppId` has access.", + "example": "9fk3m361-f12r-04b9-p39f-rio2m3pw9v8s" + }, + { + "name": "bankCode", + "schema": "string", + "required": false, + "description": "Filters for banks with a BIC (or BLZ, if German) that matches this `bankCode`. The BIC must have a string length of 8 or 11. The BLZ must have a string length of 8.", + "example": "NBAGDE3E" + }, + { + "name": "countries", + "schema": "array", + "required": false, + "description": "Filters for banks that are located in the countries specified by this list of ISO 3166-1 Alpha 2 country codes, in upper case." + }, + { + "name": "providers", + "schema": "array", + "required": false, + "description": "Filters for banks that are accessed through any of this list of providers.", + "example": "Token.io" + }, + { + "name": "bankFeaturesSupportsSendPaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support payment initiation.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsReceivePaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support the receipt of payments.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsBalanceValue", + "schema": "boolean", + "required": false, + "description": "Filters for the banks that support retrieving account balances.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsScheduledPaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support future dated scheduled payments.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsStandingOrderValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support standing orders/recurring payments.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesRequiresOneStepPaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that only support immediate redemption of transfer tokens.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsFundsConfirmationValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support confirmation of available funds.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsReturnRefundAccountValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support the request of refund account.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsTransactionsDateFilterValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support retrieving transactions by date filter.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsAccountInformationValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support retrieving account information using Account Information Services (https://reference.token.io/.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsSinglePaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support single immediate payments.", + "example": false, + "default": false + }, + { + "name": "bankFeaturesSupportsVariableRecurringPaymentValue", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support variable recurring payments.", + "example": false, + "default": false + }, + { + "name": "memberId", + "schema": "string", + "required": false, + "description": "The Token.io-assigned member id of the TPP.", + "example": "m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq" + }, + { + "name": "supportedPaymentNetworks", + "schema": "array", + "required": false, + "description": "Filters for banks that support any of the listed payment networks." + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/member/sub-tpps", + "method": "getList", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Sub-TPPs", + "typeScriptTag": "subTpPs", + "description": "Get sub-TPPs", + "parameters": [ + { + "name": "pageOffset", + "schema": "string", + "required": false, + "description": "The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data.
The offset is not visible to a user and should not be parsed and/or understood in any way.", + "example": "LerV6Jmex" + }, + { + "name": "pageLimit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return. This must be less than 200.", + "example": 175, + "default": 1 + }, + { + "name": "filterByCompanyNames", + "schema": "array", + "required": false, + "description": "Filters the sub-TPPs by the list of company names submitted." + }, + { + "name": "filterByRegistrationDates", + "schema": "array", + "required": false, + "description": "Filters the sub-TPPs by the list of registration dates submitted." + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/member/sub-tpps", + "method": "createSubTpp", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Sub-TPPs", + "typeScriptTag": "subTpPs", + "description": "Create a sub-TPP", + "parameters": [ + { + "name": "domain", + "schema": "string", + "required": true, + "description": "", + "example": "somehost.example.com" + }, + { + "name": "logo", + "schema": "string", + "required": false, + "description": "", + "example": "b0Y5cVl6aDc3RkE5blZyQ24yamlh" + }, + { + "name": "merchant", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "Sub-TPP Business Ltd" + }, + { + "name": "parentSubTppId", + "schema": "string", + "required": false, + "description": "", + "example": "6f34h397-b29h-23b0-s30g-hkd0d2dk4k1s" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/member/sub-tpps/{subTppId}", + "method": "deleteSubTpp", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Sub-TPPs", + "typeScriptTag": "subTpPs", + "description": "Delete a sub-TPP", + "parameters": [ + { + "name": "subTppId", + "schema": "string", + "required": true, + "description": "Specifies the sub-TPP to delete.", + "example": "8d54f066-c14a-47c0-b58b-fec6b0ed6b4c" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "No data returned in the successful response." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/member/sub-tpps/{subTppId}", + "method": "getSubTppInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Sub-TPPs", + "typeScriptTag": "subTpPs", + "description": "Get sub-TPP information", + "parameters": [ + { + "name": "subTppId", + "schema": "string", + "required": true, + "description": "This id specifies the sub-TPP to be retrieved.", + "example": "8d54f066-c14a-47c0-b58b-fec6b0ed6b4c" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/member/sub-tpps/{subTppId}/children", + "method": "getChildren", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Sub-TPPs", + "typeScriptTag": "subTpPs", + "description": "Get sub-TPP children", + "parameters": [ + { + "name": "subTppId", + "schema": "string", + "required": true, + "description": "Specifies the sub-TPP for which the children are to be retrieved.", + "example": "8d54f066-c14a-47c0-b58b-fec6b0ed6b4c" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Contains each sub-TPP member onboarded by the reseller." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/reports/banks/status", + "method": "getBankStatus", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Reports", + "typeScriptTag": "reports", + "description": "Get bank statuses", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "Contains information on the current status of the Token.io-connected bank." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/reports/banks/{bankId}/status", + "method": "bankStatus", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Reports", + "typeScriptTag": "reports", + "description": "Get a bank status", + "parameters": [ + { + "name": "bankId", + "schema": "string", + "required": true, + "description": "The Token.io bank identifier, identical to the `id` in the repsonse to `GET /banks`.", + "example": "goldbank" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/token-requests", + "method": "initiateTokenRequest", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Requests", + "typeScriptTag": "requests", + "description": "Initiate a token request", + "parameters": [ + { + "name": "requestOptions", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "requestPayload", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/token-requests/{tokenRequestId}/result", + "method": "checkTokenResult", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Requests", + "typeScriptTag": "requests", + "description": "Get a token request", + "parameters": [ + { + "name": "tokenRequestId", + "schema": "string", + "required": true, + "description": "The token request id received in response to the original token request.", + "example": "rq:ej5ACWNwi1EcqBeuDPc4Z8C4Bgc:5zKtXEAq" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/callback/initiation", + "method": "processBankCallback", + "httpMethod": HttpMethodsEnum.POST, + "tag": "TSP", + "typeScriptTag": "tsp", + "description": "Initiate a callback", + "parameters": [ + { + "name": "query", + "schema": "string", + "description": "", + "example": "param1=value1¶m2=value2" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/tokens", + "method": "getAll", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Tokens", + "typeScriptTag": "tokens", + "description": "Get tokens", + "parameters": [ + { + "name": "type", + "schema": "string", + "required": false, + "description": "Specifies the type of token returned.", + "example": "ACCESS", + "default": "INVALID" + }, + { + "name": "pageOffset", + "schema": "string", + "required": false, + "description": "The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data.
The offset is not visible to a user and should not be parsed and/or understood in any way.", + "example": "LerV6Jmex" + }, + { + "name": "pageLimit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return. This must be less than 200.", + "example": 175, + "default": 1 + }, + { + "name": "filterSourceAccountId", + "schema": "string", + "required": false, + "description": "Identifies the payer's account.", + "example": "a:J72REftaRoiaDYRDU7M9FDgf8jeh3eqek9DvKeyBWbuA:3VMczyq7r7b6HwC" + }, + { + "name": "filterDestinationAccountId", + "schema": "string", + "required": false, + "description": "Identifies the payee/beneficiary's account.", + "example": "a:f34VSeqwfWGTGH23vsa2cDgecew209jdvcd5vdfv4vds:5VSWVRqicm4Csa2" + }, + { + "name": "filterStartTimeMs", + "schema": "string", + "required": false, + "description": "The filtered list start timestamp in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000.", + "example": 67505 + }, + { + "name": "filterEndTimeMs", + "schema": "string", + "required": false, + "description": "The filtered list end timestamp in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000.", + "example": 365650 + }, + { + "name": "filterRole", + "schema": "string", + "required": false, + "description": "Filters by `accountHolder` role.", + "example": "ISSUER", + "default": "ANY" + }, + { + "name": "filterActingAsRefId", + "schema": "string", + "required": false, + "description": "Filters the list by the sub-TPP identifier generated by Token.io once a merchant has been onboarded.", + "example": "4kwl35c9sp3fwp4xq" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/tokens/{tokenId}", + "method": "getInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Tokens", + "typeScriptTag": "tokens", + "description": "Get a token", + "parameters": [ + { + "name": "tokenId", + "schema": "string", + "required": true, + "description": "Identifies a unique authorization token for a transfer, standing order, or account information access.", + "example": "tt:8zK1dic95omjWb72gvc3z3ELKbTNfnGd89MbDnM73er4:ZhBVAJSH8DeU1" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/tokens/{tokenId}/cancel", + "method": "cancelToken", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Tokens", + "typeScriptTag": "tokens", + "description": "Cancel a token", + "parameters": [ + { + "name": "tokenCustomerIpAddress", + "schema": "string", + "required": false, + "description": "The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (https://reference.token.io/, it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a `customer-initiated` = `true` header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.", + "example": "172.16.254.1" + }, + { + "name": "tokenId", + "schema": "string", + "required": true, + "description": "Identifies a unique authorization token for a transfer, standing order, or account information access.", + "example": "ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/transfers", + "method": "getTransfers", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Single Immediate Payments v1", + "typeScriptTag": "singleImmediatePaymentsV1", + "description": "Get transfers", + "parameters": [ + { + "name": "tokenId", + "schema": "string", + "required": false, + "description": "Identifies the authorization token for the request.", + "example": "rq:ej5ACWNwi1EcqBeuDPc4Z8C4Bgc:5zKtXEAq" + }, + { + "name": "pageOffset", + "schema": "string", + "required": false, + "description": "The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data.
The offset is not visible to a user and should not be parsed and/or understood in any way.", + "example": "LerV6Jmex" + }, + { + "name": "pageLimit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return. This must be less than 200.", + "example": 175, + "default": 1 + }, + { + "name": "filterTokenId", + "schema": "string", + "required": false, + "description": "Filters by the token id.", + "example": "tt:3kFGtpEKHu8S2fJuEkb6YPnHZ4bJ2oUrYPCsJop68vCH:5zKcENpV" + }, + { + "name": "filterStartTimeMs", + "schema": "string", + "required": false, + "description": "Filtered list start time boundary in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000.", + "example": 72799 + }, + { + "name": "filterEndTimeMs", + "schema": "string", + "required": false, + "description": "Filtered list end time boundary in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000.", + "example": 3341983424 + }, + { + "name": "filterTransactionStatus", + "schema": "string", + "required": false, + "description": "Filters by transaction status.
  • PROCESSING – This status indicates that the transaction is in process and that the final status has not been received from the bank.
  • SUCCESS – This status indicates that successful payment initiation has been received from the bank. Settlement might not be complete.
  • INITIATED – This status is set when the status has remained as PROCESSING for 30 days and cannot be updated. The transaction has been initiated but the result is unknown. This is the final status and will not be updated later.
  • PENDING – This status indicates that the user has successfully completed the authorization process at the bank and the transfer is pending redemption. This status is only relevant for 2-step payment flows.
  • PENDING_EXTERNAL_AUTHORIZATION – This status indicates that the user has been sent to the bank to complete the authorization process. If not completed within the allowed timeframe (usually around 15 mins, but there are variations between banks) the transaction will expire and transition to `FAILURE_EXPIRED`. This status is only relevant for 1-step payment flows.
  • FAILURE_GENERIC – This status usually indicates a technical failure. Possibly, a failure callback was received from the bank, with no transaction status and no further information.
  • FAILURE_PERMISSION_DENIED – This status indicates that the user has been denied authorization at the bank This status is only relevant for 2-step payment flows.
  • FAILURE_CANCELED – This status indicates that the payment initiation has been canceled before execution.
  • FAILURE_EXPIRED – This status indicates that the user did not complete the authorization process within the allowed timeframe (usually around 15 mins, but there are variations between banks) and the payment has expired.
  • FAILURE_INSUFFICIENT_FUNDS – This status indicates that the payment initiation request has been rejected due to insufficient funds.
  • FAILURE_DECLINED – This status indicates that the payment initiation has been rejected by the bank.
  • SETTLEMENT_IN_PROGRESS – This status is provided when a Token.io virtual account is used as the beneficiary for the payment, and replaces the payment initiation status. Token.io is waiting for the payment to reach the payee bank. No action is required; await the next step, e.g., Token.io sends a webhook with the status update, or a polling call. The status will change to `SETTLEMENT_IN_PROGRESS` soon after Token.io receives the final status from the debtor bank.
  • SETTLEMENT_COMPLETED – This status is provided when a Token.io virtual account is used as the beneficiary for the payment, and replaces the payment initiation status. The payment has reached the payee bank and Token.io has matched the transaction in the TPP’s settlement account to the initiated payment. For instant payments, `SETTLEMENT_COMPLETED` will be achieved within 30-45 minutes from payment initiation, at the latest. For non-instant payments, the time to reach `SETTLEMENT_COMPLETED` will depend on the clearing period for the payment.
  • SETTLEMENT_INCOMPLETE – This status is provided when a Token.io virtual account is used as the beneficiary for the payment, and replaces the payment initiation status. Reconciliation has failed. This happens when Token.io doesn't find the corresponding transaction in the TPP’s settlement account automatically.

During settlement of a virtual accounts payment, the status update job will run first for up to 30 days. Payment will then enter into a 'final' status, normally `SUCCESS`.
Once the status update job has run, the reconciliation job looks for matching inbound payments.

For SEPA payments:
  • if a matching inbound payment is found within 15 days of the final payment status update -> `SETTLEMENT_COMPLETED`
  • if no matching inbound payment is found within 15 days of the final payment status update -> `SETTLEMENT_INCOMPLETE`
For SEPA Instant payments:
  • if a matching inbound payment is found within 1 day of the final payment status update -> `SETTLEMENT_COMPLETED`
  • if no matching inbound payment is found within 1 day of the final payment status update -> `SETTLEMENT_INCOMPLETE`
", + "example": "SUCCESS" + }, + { + "name": "filterRole", + "schema": "string", + "required": false, + "description": "Filters list by the account holder role.", + "example": "PAYER" + }, + { + "name": "filterActingAsRefId", + "schema": "string", + "required": false, + "description": "Filters the list by the sub-TPP identifier generated by Token.io once a merchant has been onboarded.", + "example": "4kwl35c9sp3fwp4xq" + }, + { + "name": "filterRefId", + "schema": "string", + "required": false, + "description": "Filters list by `refID`.", + "example": "9htio4a1sp2akdr1aa" + }, + { + "name": "filterTransferRefundStatus", + "schema": "string", + "required": false, + "description": "Filters list by refund status.", + "example": "PARTIAL" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/transfers", + "method": "createTransferRequest", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Single Immediate Payments v1", + "typeScriptTag": "singleImmediatePaymentsV1", + "description": "Redeem a transfer token", + "parameters": [ + { + "name": "payload", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/token-requests/{tokenRequestId}/authorization", + "method": "initiateBankAuthorization", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Single Immediate Payments v1", + "typeScriptTag": "singleImmediatePaymentsV1", + "description": "Initiate bank authorization", + "parameters": [ + { + "name": "tokenRequestId", + "schema": "string", + "required": true, + "description": "The token request id received in response to the original token request.", + "example": "rq:ej5ACWNwi1EcqBeuDPc4Z8C4Bgc:5zKtXEAq" + }, + { + "name": "consentAccepted", + "schema": "boolean", + "description": "", + "example": false, + "default": false + }, + { + "name": "credentials", + "schema": "object", + "description": "" + }, + { + "name": "useCredentialFlow", + "schema": "boolean", + "description": "", + "example": false, + "default": false + }, + { + "name": "useWebappCredentialsFlow", + "schema": "boolean", + "description": "", + "example": false, + "default": false + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/transfers/{transferId}", + "method": "getTransferDetails", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Single Immediate Payments v1", + "typeScriptTag": "singleImmediatePaymentsV1", + "description": "Get a transfer", + "parameters": [ + { + "name": "transferId", + "schema": "string", + "required": true, + "description": "The unique id of the transfer sent in the `POST /transfers` response and/or included in a respective `GET /transfers` response.", + "example": "TRANSFERID" + }, + { + "name": "skipTransferUpdate", + "schema": "boolean", + "required": false, + "description": "If `skipTransferUpdate` is false, the request will call the bank for a status update. If set to true, the cached result will be returned instead.", + "example": false, + "default": false + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/webhook/config", + "method": "deleteConfig", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Webhooks", + "typeScriptTag": "webhooks", + "description": "Delete webhook config", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "No data returned in the successful response." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/webhook/config", + "method": "getConfig", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Webhooks", + "typeScriptTag": "webhooks", + "description": "Get webhook config", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "Specifies details of the webhook." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/webhook/config", + "method": "setConfig", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Webhooks", + "typeScriptTag": "webhooks", + "description": "Set webhook config", + "parameters": [ + { + "name": "config", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "No data included or required in the response." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/vrp-consents", + "method": "getConsents", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Variable Recurring Payments", + "typeScriptTag": "variableRecurringPayments", + "description": "Get VRP consents", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return.", + "example": 10 + }, + { + "name": "offset", + "schema": "string", + "required": false, + "description": "The offset from the previous page.", + "example": "LerV6Jmex" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/vrp-consents", + "method": "createConsent", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Variable Recurring Payments", + "typeScriptTag": "variableRecurringPayments", + "description": "Create a VRP consent", + "parameters": [ + { + "name": "initiation", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "pispConsentAccepted", + "schema": "boolean", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/vrp-consents/{id}", + "method": "revokeConsent", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Variable Recurring Payments", + "typeScriptTag": "variableRecurringPayments", + "description": "Revoke a VRP consent", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "", + "example": "vc:12345abcd:abcde" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/vrp-consents/{id}", + "method": "getConsentDetails", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Variable Recurring Payments", + "typeScriptTag": "variableRecurringPayments", + "description": "Get a VRP consent", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "", + "example": "vc:12345abcd:abcde" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/vrp-consents/{id}/payments", + "method": "getPaymentsUnderConsent", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Variable Recurring Payments", + "typeScriptTag": "variableRecurringPayments", + "description": "Get payments under a VRP consent", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "VRP consent id", + "example": "vc:12345abcd:abcde" + }, + { + "name": "limit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return.", + "example": 10 + }, + { + "name": "offset", + "schema": "string", + "required": false, + "description": "The offset from the previous page.", + "example": "LerV6Jmex" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/vrps", + "method": "listPayments", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Variable Recurring Payments", + "typeScriptTag": "variableRecurringPayments", + "description": "Get VRP payments", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return.", + "example": 10 + }, + { + "name": "offset", + "schema": "string", + "required": false, + "description": "The offset from the previous page.", + "example": "LerV6Jmex" + }, + { + "name": "ids", + "schema": "array", + "required": false, + "description": "Filters vrp payments by their ids - returns only payments with ids listed in this parameter.", + "example": [ + "vrp:4QExXrhKTxfShBdcTeqFabqJJhUF:2gFUX1NDgpN", + "vrp:N5cJDFsQzVca3Qvr8kQocgEnjgX:2gFUX1NEdYA" + ] + }, + { + "name": "invertIds", + "schema": "boolean", + "required": false, + "description": "Invert ids query - returns only vrp payments with ids not listed in the ids parameter.", + "example": false + }, + { + "name": "statuses", + "schema": "array", + "required": false, + "description": "Filters vrp payments by their statuses - returns only payments with statuses listed in this parameter.", + "example": [ + "INITIATION_COMPLETED", + "INITIATION_REJECTED" + ] + }, + { + "name": "invertStatuses", + "schema": "boolean", + "required": false, + "description": "Invert statuses query - returns only vrp payments with statuses not listed in the statuses parameter.", + "example": true + }, + { + "name": "createdAfter", + "schema": "string", + "required": false, + "description": "Returns only vrp payments created after this time (in ISO 8601 format).", + "example": "2022-04-05T17:00:00.000Z" + }, + { + "name": "createdBefore", + "schema": "string", + "required": false, + "description": "Returns only vrp payments created before this time (in ISO 8601 format).", + "example": "2022-04-05T17:00:00.000Z" + }, + { + "name": "refIds", + "schema": "array", + "required": false, + "description": "Filters vrp payments by their `refId` values - returns only payments with `refIds` listed in this parameter.", + "example": [ + "ShBdcTeqFabqJJhUF", + "N5cJDFsQzVca3Q" + ] + }, + { + "name": "vrpConsentId", + "schema": "string", + "required": false, + "description": "Filters vrp payments by their `VRP consent id` value - returns only payments with `vrpConsentId` listed in this parameter.", + "example": "vc:12345abcd:abcde" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The request does not have valid authentication credentials needed to perform the operation." + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/vrps", + "method": "initiatePayment", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Variable Recurring Payments", + "typeScriptTag": "variableRecurringPayments", + "description": "Initiate a VRP payment", + "parameters": [ + { + "name": "initiation", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/vrps/{id}", + "method": "getPaymentDetails", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Variable Recurring Payments", + "typeScriptTag": "variableRecurringPayments", + "description": "Get a VRP payment", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "VRP id", + "example": "vrp:12345abcd:abcde" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/vrps/{id}/confirm-funds", + "method": "checkFundsAvailability", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Variable Recurring Payments", + "typeScriptTag": "variableRecurringPayments", + "description": "Verify if funds are available or not", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "The VRP consent id.", + "example": "vc:12345abcd:abcde" + }, + { + "name": "amount", + "schema": "string", + "required": true, + "description": "The amount to confirm availability for.", + "example": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "A flag indicating whether funds are available or not. If set to `true`, funds are available for transfer." + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/refunds", + "method": "getList", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Refunds - BETA", + "typeScriptTag": "refundsBeta", + "description": "Get refunds", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return.", + "example": 10 + }, + { + "name": "offset", + "schema": "string", + "required": false, + "description": "The offset from the previous page.", + "example": "LerV6Jmex" + }, + { + "name": "startDate", + "schema": "string", + "required": false, + "description": "Lower bound for a refund creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only refunds created at or after the given date will be returned.", + "example": "2010-01-01" + }, + { + "name": "endDate", + "schema": "string", + "required": false, + "description": "Upper bound for a refund creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only refunds created at or before the given date will be returned.", + "example": "2010-01-01" + }, + { + "name": "ids", + "schema": "array", + "required": false, + "description": "Filters refunds by their ids - returns only refunds with ids listed in this parameter.", + "example": [ + "rf:4QExXrhKTxfShBdcTeqFabqJJhUF:2gFUX1NDgpN", + "rf:N5cJDFsQzVca3Qvr8kQocgEnjgX:2gFUX1NEdYA" + ] + }, + { + "name": "invertIds", + "schema": "boolean", + "required": false, + "description": "Invert ids query - returns only refunds with ids not listed in the ids parameter.", + "example": false + }, + { + "name": "statuses", + "schema": "array", + "required": false, + "description": "Filters refunds by their statuses - returns only refunds with statuses listed in this parameter.", + "example": [ + "INITIATION_COMPLETED", + "INITIATION_REJECTED" + ] + }, + { + "name": "invertStatuses", + "schema": "boolean", + "required": false, + "description": "Invert statuses query - returns only refunds with statuses not listed in the statuses parameter.", + "example": true + }, + { + "name": "refIds", + "schema": "array", + "required": false, + "description": "Filters refunds by their `refId` values - returns only refunds with `refIds` listed in this parameter.", + "example": [ + "ShBdcTeqFabqJJhUF", + "N5cJDFsQzVca3Q" + ] + }, + { + "name": "partial", + "schema": "boolean", + "required": false, + "description": "Returns refunds in a partial format - with only id and status fields populated.", + "example": true + }, + { + "name": "onBehalfOfIds", + "schema": "array", + "required": false, + "description": "The result can be filtered on the basis of multiple OnBehalfOfIds.", + "example": [ + "c5a863bc-86f2-4418-a26f-25b24c7983c7", + "6f34h397-b29h-23b0-s30g-hkd0d2dk4k1s" + ] + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/refunds", + "method": "initiateRefund", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Refunds - BETA", + "typeScriptTag": "refundsBeta", + "description": "Initiate a refund", + "parameters": [ + { + "name": "initiation", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/refunds/{id}", + "method": "getRefund", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Refunds - BETA", + "typeScriptTag": "refundsBeta", + "description": "Get a refund", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "", + "example": "your refund id" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/transfers/{id}/refunds", + "method": "getAllRefunds", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Refunds - BETA", + "typeScriptTag": "refundsBeta", + "description": "Get all refunds by transfer", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return.", + "example": 10 + }, + { + "name": "offset", + "schema": "string", + "required": false, + "description": "The offset from the previous page.", + "example": "LerV6Jmex" + }, + { + "name": "id", + "schema": "string", + "required": true, + "description": "", + "example": "your transfer id" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/payouts", + "method": "getList", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Payouts - BETA", + "typeScriptTag": "payoutsBeta", + "description": "Get payouts", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return.", + "example": 10 + }, + { + "name": "offset", + "schema": "string", + "required": false, + "description": "The offset from the previous page.", + "example": "LerV6Jmex" + }, + { + "name": "startDate", + "schema": "string", + "required": false, + "description": "Lower bound for a payout creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only payouts created at or after the given date will be returned.", + "example": "2010-01-01" + }, + { + "name": "endDate", + "schema": "string", + "required": false, + "description": "Upper bound for a payout creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only payouts created at or before the given date will be returned.", + "example": "2010-01-01" + }, + { + "name": "ids", + "schema": "array", + "required": false, + "description": "Filters payouts by their ids - returns only payouts with ids listed in this parameter.", + "example": [ + "po:28oivvd3iFhBrcbNj4tmtLEhxRTk:2gFUX1NE1T6", + "po:3ZfdHxbpXmRZ1TVmiYNPgcwEocBy:2gFUX1NDdqr" + ] + }, + { + "name": "invertIds", + "schema": "boolean", + "required": false, + "description": "Invert ids query - returns only payouts with ids not listed in the ids parameter.", + "example": false + }, + { + "name": "statuses", + "schema": "array", + "required": false, + "description": "Filters payouts by their statuses - returns only payouts with statuses listed in this parameter.", + "example": [ + "INITIATION_COMPLETED", + "INITIATION_REJECTED" + ] + }, + { + "name": "invertStatuses", + "schema": "boolean", + "required": false, + "description": "Invert statuses query - returns only payouts with statuses not listed in the statuses parameter.", + "example": true + }, + { + "name": "refIds", + "schema": "array", + "required": false, + "description": "Filters payouts by their `refId` values - returns only payouts with `refIds` listed in this parameter.", + "example": [ + "ShBdcTeqFabqJJhUF", + "N5cJDFsQzVca3Q" + ] + }, + { + "name": "onBehalfOfId", + "schema": "string", + "required": false, + "description": "Filters payouts by their `onBehalfOfId` value - returns only payouts with `onBehalfOfId` listed in this parameter.", + "example": "onBahalfOfId001" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/payouts", + "method": "initializePayout", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Payouts - BETA", + "typeScriptTag": "payoutsBeta", + "description": "Initiate a payout", + "parameters": [ + { + "name": "initiation", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/payouts/{id}", + "method": "getPayout", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Payouts - BETA", + "typeScriptTag": "payoutsBeta", + "description": "Get a payout", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "", + "example": "your payout id" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/secrets/upload/key-and-certificate", + "method": "uploadKeyAndCertificate", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Refunds - BETA", + "typeScriptTag": "refundsBeta", + "description": "Upload a private key and certificate", + "parameters": [ + { + "name": "upload", + "schema": "undefined", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/v2/banks", + "method": "getList", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Banks v2", + "typeScriptTag": "banksV2", + "description": "Get banks v2", + "parameters": [ + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The index of the page currently being retrieved." + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "The number of records per page.", + "example": 10, + "default": 200 + }, + { + "name": "sort", + "schema": "string", + "required": false, + "description": "The key to sort the result. This can be `NAME` (Bank's name), `STANDARD` (https://reference.token.io/, `RANK`, or `COUNTRY`.", + "example": "COUNTRY", + "default": "NAME" + }, + { + "name": "memberId", + "schema": "string", + "required": false, + "description": "The Token.io-assigned member id of the TPP." + }, + { + "name": "tppId", + "schema": "string", + "required": false, + "description": "Filters for banks for which the TPP represented by this `tppId` has access." + }, + { + "name": "ids", + "schema": "array", + "required": false, + "description": "Filters for banks with a `bankId` (https://reference.token.io/ matching any of the ids listed, up to a maximum of 1000. Only exact (full string) matches are returned." + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "Filters for banks with a name or identifiers containing this search string.", + "example": "hsbc" + }, + { + "name": "bankGroup", + "schema": "string", + "required": false, + "description": "Filters for banks that are members of the bank group specified.", + "example": [ + "HSBC", + "Coop" + ] + }, + { + "name": "bankSubGroup", + "schema": "string", + "required": false, + "description": "Filters for banks that are part of the bank sub-group specified.", + "example": [ + "CMM Grand", + "Banque Populaire", + "La Banque" + ] + }, + { + "name": "bankCode", + "schema": "string", + "required": false, + "description": "Filters for banks with a BIC (or BLZ, if German) that matches this `bankCode`. The BIC must have a string length of 8 or 11. The BLZ must have a string length of 8." + }, + { + "name": "openBankingStandards", + "schema": "array", + "required": false, + "description": "Filters for banks that are accessed through any of the listed standards." + }, + { + "name": "countries", + "schema": "array", + "required": false, + "description": "Filters for banks that are located in the countries specified by this list of ISO 3166-1 Alpha 2 country codes, in upper case." + }, + { + "name": "bics", + "schema": "array", + "required": false, + "description": "Filters for banks whose BIC matches any of the listed BICs (https://reference.token.io/, up to a maximum of 1000." + }, + { + "name": "supportedLocalInstruments", + "schema": "array", + "required": false, + "description": "Filters for banks that support any of the listed payment networks.", + "example": [ + "SEPA_INSTANT", + "FASTER_PAYMENTS", + "SEPA" + ] + }, + { + "name": "supportsAccountList", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support fetching accounts." + }, + { + "name": "supportsAccountDetails", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support fetching account details." + }, + { + "name": "supportsAccountBalance", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support fetching account balances." + }, + { + "name": "supportsTransactionList", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support fetching transactions." + }, + { + "name": "supportsTransactionDetails", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support fetching transaction details." + }, + { + "name": "supportsStandingOrderList", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support the fetching standing orders." + }, + { + "name": "supportsTransactionsDateFilter", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support feting transactions using a date filter." + }, + { + "name": "requiresOneStepPayment", + "schema": "boolean", + "required": false, + "description": "Filters for banks that only support immediate redemption of transfers." + }, + { + "name": "supportsSinglePayment", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support single immediate payments.", + "example": true + }, + { + "name": "supportsScheduledPayment", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support future dated scheduled payments." + }, + { + "name": "supportsStandingOrder", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support recurring payments/standing orders." + }, + { + "name": "supportsReturnRefundAccount", + "schema": "boolean", + "required": false, + "description": "Filters for the banks that support request of refund account." + }, + { + "name": "supportsReturnRefundAccountHolderName", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support returning the refund account holder name." + }, + { + "name": "supportsFundsConfirmation", + "schema": "boolean", + "required": false, + "description": "Filters for the banks that support confirmation of available funds." + }, + { + "name": "supportsVariableRecurringPayment", + "schema": "boolean", + "required": false, + "description": "Filters for banks that support variable recurring payments." + }, + { + "name": "bankSubGroup", + "schema": "string", + "required": false, + "description": "Filters for banks that are part of the bank sub-group specified.", + "example": [ + "CMM Grand", + "Banque Populaire", + "La Banque" + ] + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/v2/payments", + "method": "listPayments", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Single Immediate Payments v2", + "typeScriptTag": "singleImmediatePaymentsV2", + "description": "Get payments", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "required": true, + "description": "The maximum number of records to return.", + "example": 10 + }, + { + "name": "offset", + "schema": "string", + "required": false, + "description": "The offset from the previous page.", + "example": "LerV6Jmex" + }, + { + "name": "ids", + "schema": "array", + "required": false, + "description": "Filters payments by their ids - returns only payments with ids listed in this parameter.", + "example": [ + "pm2:4QExXrhKTxfShBdcTeqFabqJJhUF:2gFUX1NDgpN", + "pm2:N5cJDFsQzVca3Qvr8kQocgEnjgX:2gFUX1NEdYA" + ] + }, + { + "name": "invertIds", + "schema": "boolean", + "required": false, + "description": "Invert ids query - returns only payments with ids not listed in the ids parameter.", + "example": false + }, + { + "name": "statuses", + "schema": "array", + "required": false, + "description": "Filters payments by their statuses - returns only payments with statuses listed in this parameter.", + "example": [ + "INITIATION_COMPLETED", + "INITIATION_REJECTED" + ] + }, + { + "name": "invertStatuses", + "schema": "boolean", + "required": false, + "description": "Invert statuses query - returns only payments with statuses not listed in the statuses parameter.", + "example": true + }, + { + "name": "createdAfter", + "schema": "string", + "required": false, + "description": "Returns only payments created after this time (in ISO 8601 format).", + "example": "2022-04-05T17:00:00.000Z" + }, + { + "name": "createdBefore", + "schema": "string", + "required": false, + "description": "Returns only payments created before this time (in ISO 8601 format).", + "example": "2022-04-05T17:00:00.000Z" + }, + { + "name": "refIds", + "schema": "array", + "required": false, + "description": "Filters payments by their `refId` values - returns only payments with `refIds` listed in this parameter.", + "example": [ + "ShBdcTeqFabqJJhUF", + "N5cJDFsQzVca3Q" + ] + }, + { + "name": "onBehalfOfId", + "schema": "string", + "required": false, + "description": "Filters payments by the `onBehalfOfId` value - returns only payments with `onBehalfOfId` specified in this parameter.", + "example": "c5a863bc-86f2-4418-a26f-25b24c7983c7" + }, + { + "name": "refundStatuses", + "schema": "array", + "required": false, + "description": "Filters payments by their refund status values - returns only payments with refund statuses listed in this parameter.", + "example": [ + "PARTIAL", + "NONE" + ] + }, + { + "name": "partial", + "schema": "boolean", + "required": false, + "description": "Returns payments in a partial format - with only id and status fields populated.", + "example": true + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "The request does not have valid authentication credentials needed to perform the operation." + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v2/payments", + "method": "initiatePayment", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Single Immediate Payments v2", + "typeScriptTag": "singleImmediatePaymentsV2", + "description": "Initiate a payment", + "parameters": [ + { + "name": "requestTimeout", + "schema": "integer", + "required": false, + "description": "Sets the number of elapsed seconds until the call is aborted with a `DEADLINE_EXCEEDED` exception due to no response received.", + "example": 10 + }, + { + "name": "initiation", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "pispConsentAccepted", + "schema": "boolean", + "required": false, + "description": "", + "example": false, + "default": false + }, + { + "name": "initialEmbeddedAuth", + "schema": "object", + "required": false, + "description": "", + "example": { + "username": "John Smith" + } + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v2/payments/{paymentId}/embedded-auth", + "method": "provideEmbeddedAuthInfo", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Single Immediate Payments v2", + "typeScriptTag": "singleImmediatePaymentsV2", + "description": "Provide information for embedded authentication", + "parameters": [ + { + "name": "paymentId", + "schema": "string", + "required": true, + "description": "", + "example": "PAYMENTID" + }, + { + "name": "embeddedAuth", + "schema": "object", + "description": "", + "example": { + "123": "SMS message" + } + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v2/payments/{paymentId}", + "method": "getPaymentDetails", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Single Immediate Payments v2", + "typeScriptTag": "singleImmediatePaymentsV2", + "description": "Get a payment", + "parameters": [ + { + "name": "paymentId", + "schema": "string", + "required": true, + "description": "", + "example": "PAYMENTID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/virtual-accounts", + "method": "getAll", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Virtual Accounts - BETA", + "typeScriptTag": "virtualAccountsBeta", + "description": "Get virtual accounts", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "required": false, + "description": "The maximum number of records to return.
The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200." + }, + { + "name": "offset", + "schema": "string", + "required": false, + "description": "The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value from the previous page response.
The offset value should not be parsed and/or understood in any way." + }, + { + "name": "currency", + "schema": "string", + "required": false, + "description": "The ISO 4217 three letter currency code.", + "example": "EUR" + }, + { + "name": "country", + "schema": "string", + "required": false, + "description": "The ISO 3166-1 Alpha 2 country codes.", + "example": "PL" + }, + { + "name": "nickname", + "schema": "string", + "required": false, + "description": "The alias name that identifies the virtual account.", + "example": "Account Alias" + }, + { + "name": "onBehalfOfId", + "schema": "string", + "required": false, + "description": "An id of the ultimate client on whose behalf the account is created. If the account is created on behalf of a sub-TPP, this field should contain the sub-TPP `referenceId`.", + "example": "c5a863bc-86f2-4418-a26f-25b24c7983c7" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Contains the response to the get virtual accounts request." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/virtual-accounts", + "method": "createAccount", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Virtual Accounts - BETA", + "typeScriptTag": "virtualAccountsBeta", + "description": "Create a virtual account", + "parameters": [ + { + "name": "accountNickName", + "schema": "string", + "required": false, + "description": "", + "example": "Account Alias" + }, + { + "name": "currency", + "schema": "string", + "required": true, + "description": "", + "example": "EUR" + }, + { + "name": "onBehalfOfId", + "schema": "string", + "required": false, + "description": "", + "example": [ + "c5a863bc-86f2-4418-a26f-25b24c7983c7", + "6f34h397-b29h-23b0-s30g-hkd0d2dk4k1s" + ] + }, + { + "name": "country", + "schema": "string", + "required": true, + "description": "", + "example": "COUNTRY" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Contains the response to the submitted request." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/virtual-accounts/{accountId}", + "method": "getInfo", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Virtual Accounts - BETA", + "typeScriptTag": "virtualAccountsBeta", + "description": "Get a virtual account", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "", + "example": "ACCOUNTID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Contains the response to the create virtual account request." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/virtual-accounts/{accountId}/transactions", + "method": "getTransactions", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Virtual Accounts - BETA", + "typeScriptTag": "virtualAccountsBeta", + "description": "Get virtual account transactions", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "", + "example": "ACCOUNTID" + }, + { + "name": "limit", + "schema": "integer", + "required": false, + "description": "The maximum number of records to return.
The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200." + }, + { + "name": "offset", + "schema": "string", + "required": false, + "description": "The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value from the previous page response.
The offset value should not be parsed and/or understood in any way." + }, + { + "name": "refId", + "schema": "string", + "required": false, + "description": "Filters transactions by their `refId` value - returns only transactions with `refId` mentioned in the reference." + }, + { + "name": "startDate", + "schema": "string", + "required": false, + "description": "Returns transactions created on or after this date, inclusive (in ISO 8601 format).", + "example": "2022-04-05" + }, + { + "name": "endDate", + "schema": "string", + "required": false, + "description": "Returns transactions created on or before this date, inclusive (in ISO 8601 format).", + "example": "2022-04-05" + }, + { + "name": "amount", + "schema": "string", + "required": false, + "description": "Filters transactions by their transaction amount." + }, + { + "name": "providerPaymentId", + "schema": "string", + "required": false, + "description": "Filters transactions by the provider-payment-id." + }, + { + "name": "transactionType", + "schema": "string", + "required": false, + "description": "Filters transactions by type to include only CREDIT or DEBIT transactions.", + "example": "CREDIT", + "default": "INVALID_TYPE" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/virtual-accounts/{accountId}/transactions/{providerPaymentId}", + "method": "getTransaction", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Virtual Accounts - BETA", + "typeScriptTag": "virtualAccountsBeta", + "description": "Get a virtual account transaction", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "", + "example": "ACCOUNTID" + }, + { + "name": "providerPaymentId", + "schema": "string", + "required": true, + "description": "", + "example": "PROVIDERPAYMENTID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/virtual-accounts/{account_id}/settlement-rule", + "method": "createSettlementRule", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Virtual Accounts - BETA", + "typeScriptTag": "virtualAccountsBeta", + "description": "Create a settlement rule", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "", + "example": "ACCOUNT_ID" + }, + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "", + "example": "pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV" + }, + { + "name": "payeeAccountDetails", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "amountType", + "schema": "string", + "required": true, + "description": "", + "example": "AMOUNTTYPE" + }, + { + "name": "amountValue", + "schema": "string", + "required": true, + "description": "", + "example": 10 + }, + { + "name": "timeInterval", + "schema": "string", + "required": true, + "description": "", + "example": "TIMEINTERVAL" + }, + { + "name": "effectiveFrom", + "schema": "string", + "required": false, + "description": "", + "example": "2024-01-01T12:34:56Z" + }, + { + "name": "effectiveTo", + "schema": "string", + "required": false, + "description": "", + "example": "2024-12-01T12:34:56Z" + }, + { + "name": "intradayIntervalHours", + "schema": "integer", + "required": false, + "description": "", + "example": 2 + }, + { + "name": "intradayIntervalMinutes", + "schema": "integer", + "required": false, + "description": "", + "example": 10 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Contains the response of the create virtual account settlement rule request." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/virtual-accounts/{account_id}/settlement-rules/{settlement_rule_id}", + "method": "deleteSettlementRule", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Virtual Accounts - BETA", + "typeScriptTag": "virtualAccountsBeta", + "description": "Delete a settlement rule", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The id of the virtual account.", + "example": "ACCOUNT_ID" + }, + { + "name": "settlementRuleId", + "schema": "string", + "required": true, + "description": "The id of the settlement rule.", + "example": "SETTLEMENT_RULE_ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "No data returned in the successful response." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/virtual-accounts/{account_id}/settlement-rules/{settlement_rule_id}", + "method": "getRule", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Virtual Accounts - BETA", + "typeScriptTag": "virtualAccountsBeta", + "description": "Get a settlement rule", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The id of the virtual account.", + "example": "ACCOUNT_ID" + }, + { + "name": "settlementRuleId", + "schema": "string", + "required": true, + "description": "The id of the settlement rule.", + "example": "SETTLEMENT_RULE_ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Contains the response of the get virtual account settlement rule request." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/virtual-accounts/{account_id}/settlement-rules", + "method": "getSettlementRules", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Virtual Accounts - BETA", + "typeScriptTag": "virtualAccountsBeta", + "description": "Get settlement rules", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The id of the virtual account.", + "example": "ACCOUNT_ID" + }, + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "", + "example": "pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV" + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Contains the response of the get virtual account settlement rules request." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + }, + { + "url": "/virtual-accounts/{account_id}/settlement-rule-payouts", + "method": "getSettlementPayouts", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Virtual Accounts - BETA", + "typeScriptTag": "virtualAccountsBeta", + "description": "Get virtual account settlement payouts", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "The id of the virtual account.", + "example": "ACCOUNT_ID" + }, + { + "name": "accountId", + "schema": "string", + "required": true, + "description": "", + "example": "pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV" + }, + { + "name": "limit", + "schema": "integer", + "required": false, + "description": "", + "example": 10 + }, + { + "name": "offset", + "schema": "string", + "required": false, + "description": "", + "example": "LerV6Jmex" + }, + { + "name": "settlementRuleId", + "schema": "string", + "required": false, + "description": "", + "example": "123e4567-e89b-12d3-a456-426614174000" + }, + { + "name": "startDate", + "schema": "string", + "required": false, + "description": "", + "example": "2024-01-01" + }, + { + "name": "endDate", + "schema": "string", + "required": false, + "description": "", + "example": "2024-12-01" + }, + { + "name": "ids", + "schema": "array", + "required": false, + "description": "", + "example": [ + "123e4567-e89b-12d3-a456-426614174000" + ] + }, + { + "name": "invertIds", + "schema": "boolean", + "required": false, + "description": "", + "example": false + }, + { + "name": "statuses", + "schema": "array", + "required": false, + "description": "", + "example": [ + "INITIATION_PENDING", + "INITIATION_PROCESSING" + ] + }, + { + "name": "invertStatuses", + "schema": "boolean", + "required": false, + "description": "", + "example": false + }, + { + "name": "refIds", + "schema": "array", + "required": false, + "description": "", + "example": [ + "ShBdcTeqFabqJJhUF" + ] + }, + { + "name": "onBehalfOfId", + "schema": "string", + "required": false, + "description": "", + "example": [ + "c5a863bc-86f2-4418-a26f-25b24c7983c7" + ] + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Contains the response of the get virtual account settlement payouts request." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + }, + { + "statusCode": "501", + "description": "" + }, + { + "statusCode": "503", + "description": "" + }, + { + "statusCode": "504", + "description": "" + } + ] + } +] + } + language="TypeScript" + apiTitle="Token.io's Open Banking API for TPPs" + apiBaseUrl="https://api.token.io" + apiVersion="v1.2.3.2" + endpoints={50} + sdkMethods={63} + schemas={415} + parameters={271} + difficulty="Hard" + openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/token/openapi.yaml" + openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/token/openapi.yaml" + developerDocumentation="reference.token.io/" + /> + ); +} + \ No newline at end of file