{ "swagger" : "2.0", "info" : { "description" : "Clal Insurance & Finance Open Finance Services", "version" : "2.0", "title" : "OpenFinance" }, "host" : "localhost", "basePath" : "/gateway/OpenFinance", "schemes" : [ "https" ], "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "security" : [ { "apiKey" : [ ] } ], "paths" : { "/token" : { "post" : { "operationId" : "token_POST_14", "consumes" : [ "application/x-www-form-urlencoded" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "client_id", "in" : "formData", "required" : false, "type" : "string" }, { "name" : "code", "in" : "formData", "required" : false, "type" : "string" }, { "name" : "code_verifier", "in" : "formData", "required" : false, "type" : "string" }, { "name" : "grant_type", "in" : "formData", "required" : false, "type" : "string" }, { "name" : "redirect_uri", "in" : "formData", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/token_POST_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/v1.6.0/consents/{consentId}" : { "get" : { "operationId" : "0consentsconsentId_GET_8", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "consentId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v160consentsconsentId_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } }, "delete" : { "operationId" : "0consentsconsentId_DELETE_8", "consumes" : [ ], "parameters" : [ { "name" : "consentId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" }, "204" : { "description" : "No Content" } } } }, "/v1.6.0/consents" : { "post" : { "operationId" : "0consents_POST_12", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/PostConsentPublicInput" } } ], "responses" : { "201" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v160consents_POST_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/v1/consents/{consentId}" : { "get" : { "operationId" : "v1consentsconsentId_GET_7", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "consentId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v1consentsconsentId_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } }, "delete" : { "operationId" : "v1consentsconsentId_DELETE_7", "consumes" : [ ], "parameters" : [ { "name" : "consentId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" }, "204" : { "description" : "No Content" } } } }, "/v1/consents/{consentId}/status" : { "get" : { "operationId" : "v1consentsconsentIdstatus_GET_9", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "consentId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v1consentsconsentIdstatus_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/v1.4.0/loans" : { "get" : { "operationId" : "0loans_GET_2", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v140loans_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/oauth-authorization-server" : { "get" : { "description" : "opf3 pre ver", "operationId" : "oauthauthorizationserver_GET_13", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/oauthauthorizationserver_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/v1.6.0/consents/{consentId}/status" : { "get" : { "operationId" : "0consentsconsentIdstatus_GET_10", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "consentId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v160consentsconsentIdstatus_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/v1/consents" : { "post" : { "operationId" : "v1consents_POST_11", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/PostConsentPublicInput" } } ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v1consents_POST_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/v1/loans/{loan-account-id}" : { "get" : { "operationId" : "v1loansloanaccountid_GET_3", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "loan-account-id", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v1loansloanaccountid_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/v1.4.0/loans/{loan-account-id}/balances" : { "get" : { "operationId" : "0loansloanaccountidbalances_GET_6", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "loan-account-id", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v140loansloanaccountidbalances_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/v1/loans" : { "get" : { "operationId" : "v1loans_GET_1", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v1loans_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/v1.4.0/loans/{loan-account-id}" : { "get" : { "operationId" : "0loansloanaccountid_GET_4", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "loan-account-id", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v140loansloanaccountid_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } }, "/v1/loans/{loan-account-id}/balances" : { "get" : { "operationId" : "v1loansloanaccountidbalances_GET_5", "consumes" : [ ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "loan-account-id", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "$ref" : "#/definitions/v1loansloanaccountidbalances_GET_response" } }, "400" : { "description" : "Bad Request" }, "401" : { "description" : "Bad Request" } } } } }, "securityDefinitions" : { "apiKey" : { "type" : "apiKey", "name" : "x-Gateway-APIKey", "in" : "header" } }, "definitions" : { "SingleLink" : { "type" : "object", "required" : [ "href" ], "properties" : { "href" : { "type" : "string" } } }, "oauthauthorizationserver_GET_response" : { "type" : "object", "required" : [ "authorization_endpoint", "issuer", "token_endpoint" ], "properties" : { "authorization_endpoint" : { "type" : "string" }, "issuer" : { "type" : "string" }, "token_endpoint" : { "type" : "string" } } }, "RelatedDates" : { "type" : "object", "required" : [ "EndDate", "NextExitDate", "StartDate" ], "properties" : { "EndDate" : { "type" : "string" }, "NextExitDate" : { "type" : "string" }, "StartDate" : { "type" : "string" } } }, "v160consents_POST_response" : { "type" : "object", "required" : [ "_links", "consentId", "consentStatus" ], "properties" : { "_links" : { "$ref" : "#/definitions/Links" }, "challengeData" : { "type" : "string" }, "chosenScaMethod" : { "type" : "string" }, "consentId" : { "type" : "string" }, "consentStatus" : { "type" : "string" }, "psuMessage" : { "type" : "string" }, "scaMethods" : { "type" : "string" } } }, "v140loans_GET_response" : { "type" : "object", "required" : [ "loanAccounts" ], "properties" : { "loanAccounts" : { "type" : "array", "items" : { "$ref" : "#/definitions/ResponseAccountDetails" } } } }, "v1consentsconsentId_GET_response" : { "type" : "object", "required" : [ "_links", "access", "consentStatus", "frequencyPerDay", "lastActionDate", "recurringIndicator", "validUntil" ], "properties" : { "_links" : { "$ref" : "#/definitions/Links" }, "access" : { "$ref" : "#/definitions/AccountAccess" }, "consentStatus" : { "type" : "string" }, "frequencyPerDay" : { "type" : "integer", "format" : "int32" }, "lastActionDate" : { "type" : "string" }, "recurringIndicator" : { "type" : "boolean" }, "validUntil" : { "type" : "string" } } }, "Index" : { "type" : "object", "required" : [ "additionalInformation", "index", "rootIndexValue" ], "properties" : { "additionalInformation" : { "type" : "string" }, "index" : { "type" : "string" }, "rootIndexValue" : { "type" : "string" } } }, "ResponseInterest" : { "type" : "object", "required" : [ "rate", "relatedIndices", "toDateTime", "type" ], "properties" : { "rate" : { "$ref" : "#/definitions/Rate" }, "relatedIndices" : { "type" : "array", "items" : { "$ref" : "#/definitions/Index" } }, "toDateTime" : { "type" : "string" }, "type" : { "type" : "string" } } }, "token_POST_response" : { "type" : "object", "required" : [ "access_token", "expires_in", "refresh_token", "scope", "token_type" ], "properties" : { "access_token" : { "type" : "string" }, "expires_in" : { "type" : "string" }, "refresh_token" : { "type" : "string" }, "scope" : { "type" : "string" }, "token_type" : { "type" : "string" } } }, "v160consentsconsentIdstatus_GET_response" : { "type" : "object", "required" : [ "consentStatus" ], "properties" : { "consentStatus" : { "type" : "string" }, "psuMessage" : { "type" : "string" } } }, "v1loansloanaccountidbalances_GET_response" : { "type" : "object", "required" : [ "balances", "loanAccount" ], "properties" : { "balances" : { "type" : "array", "items" : { "$ref" : "#/definitions/Balances" } }, "loanAccount" : { "$ref" : "#/definitions/AccountReference" } } }, "v1consents_POST_response" : { "type" : "object", "required" : [ "_links", "consentId", "consentStatus" ], "properties" : { "_links" : { "$ref" : "#/definitions/Links" }, "challengeData" : { "type" : "string" }, "chosenScaMethod" : { "type" : "string" }, "consentId" : { "type" : "string" }, "consentStatus" : { "type" : "string" }, "psuMessage" : { "type" : "string" }, "scaMethods" : { "type" : "string" } } }, "Rate" : { "type" : "object", "required" : [ "percentage" ], "properties" : { "percentage" : { "type" : "string" } } }, "Amount" : { "type" : "object", "required" : [ "amount", "currency" ], "properties" : { "amount" : { "type" : "string" }, "currency" : { "type" : "string" } } }, "Balances" : { "type" : "object", "required" : [ "balanceAmount", "balanceType", "creditLimitIncluded", "referenceDate" ], "properties" : { "balanceAmount" : { "$ref" : "#/definitions/Amount" }, "balanceType" : { "type" : "string" }, "creditLimitIncluded" : { "type" : "string" }, "referenceDate" : { "type" : "string" } } }, "v1loansloanaccountid_GET_response" : { "type" : "object", "required" : [ "loanAccount" ], "properties" : { "loanAccount" : { "$ref" : "#/definitions/ResponseAccountDetails" } } }, "CashAccountType" : { "type" : "object", "properties" : { "cashAccountType" : { "type" : "string" } } }, "PostConsentPublicInput" : { "type" : "object", "required" : [ "access", "combinedServiceIndicator", "frequencyPerDay", "recurringIndicator", "validUntil" ], "properties" : { "access" : { "$ref" : "#/definitions/AccountAccess" }, "combinedServiceIndicator" : { "type" : "boolean" }, "frequencyPerDay" : { "type" : "integer", "format" : "int32" }, "recurringIndicator" : { "type" : "boolean" }, "validUntil" : { "type" : "string", "format" : "date" } } }, "v140loansloanaccountidbalances_GET_response" : { "type" : "object", "required" : [ "balances", "loanAccount" ], "properties" : { "balances" : { "type" : "array", "items" : { "$ref" : "#/definitions/Balances" } }, "loanAccount" : { "$ref" : "#/definitions/AccountReference" } } }, "v160consentsconsentId_GET_response" : { "type" : "object", "required" : [ "_links", "access", "consentStatus", "frequencyPerDay", "lastActionDate", "recurringIndicator", "validUntil" ], "properties" : { "_links" : { "$ref" : "#/definitions/Links" }, "access" : { "$ref" : "#/definitions/AccountAccess" }, "consentStatus" : { "type" : "string" }, "frequencyPerDay" : { "type" : "integer", "format" : "int32" }, "lastActionDate" : { "type" : "string" }, "recurringIndicator" : { "type" : "boolean" }, "validUntil" : { "type" : "string" } } }, "v1loans_GET_response" : { "type" : "object", "required" : [ "loanAccounts" ], "properties" : { "loanAccounts" : { "type" : "array", "items" : { "$ref" : "#/definitions/ResponseAccountDetails" } } } }, "v1consentsconsentIdstatus_GET_response" : { "type" : "object", "required" : [ "consentStatus" ], "properties" : { "consentStatus" : { "type" : "string" }, "psuMessage" : { "type" : "string" } } }, "AccountAccess" : { "type" : "object", "properties" : { "accounts" : { "type" : "array", "items" : { "$ref" : "#/definitions/AccountReference" } }, "additionalInformation" : { "$ref" : "#/definitions/AdditionalInformationAccess" }, "allPsd2" : { "type" : "string" }, "availableAccounts" : { "type" : "string" }, "availableAccountsWithBalance" : { "type" : "string" }, "balances" : { "type" : "array", "items" : { "$ref" : "#/definitions/AccountReference" } }, "restrictedTo" : { "type" : "array", "items" : { "$ref" : "#/definitions/CashAccountType" } }, "transactions" : { "type" : "array", "items" : { "$ref" : "#/definitions/AccountReference" } } } }, "Links" : { "type" : "object", "properties" : { "account" : { "$ref" : "#/definitions/SingleLink" }, "balances" : { "$ref" : "#/definitions/SingleLink" }, "confirmation" : { "$ref" : "#/definitions/SingleLink" }, "scaOAuth" : { "$ref" : "#/definitions/SingleLink" }, "scaStatus" : { "$ref" : "#/definitions/SingleLink" }, "self" : { "$ref" : "#/definitions/SingleLink" }, "status" : { "$ref" : "#/definitions/SingleLink" } } }, "AdditionalInformationAccess" : { "type" : "object", "properties" : { "ownerName" : { "type" : "array", "items" : { "$ref" : "#/definitions/AccountReference" } } } }, "ResponseAccountDetails" : { "type" : "object", "required" : [ "_links", "accountReference", "balances", "bic", "collateralInvolved", "details", "displayName", "guaranteeInvolved", "interest", "linkedAccounts", "name", "ownerName", "product", "relatedDates", "resourceId", "status", "usage" ], "properties" : { "_links" : { "$ref" : "#/definitions/Links" }, "accountReference" : { "$ref" : "#/definitions/AccountReference" }, "balances" : { "type" : "array", "items" : { "$ref" : "#/definitions/Balances" } }, "bic" : { "type" : "string" }, "collateralInvolved" : { "type" : "string" }, "details" : { "type" : "string" }, "displayName" : { "type" : "string" }, "guaranteeInvolved" : { "type" : "string" }, "interest" : { "type" : "array", "items" : { "$ref" : "#/definitions/ResponseInterest" } }, "linkedAccounts" : { "type" : "string" }, "name" : { "type" : "string" }, "ownerName" : { "type" : "string" }, "product" : { "type" : "string" }, "relatedDates" : { "$ref" : "#/definitions/RelatedDates" }, "resourceId" : { "type" : "string" }, "status" : { "type" : "string" }, "usage" : { "type" : "string" } } }, "AccountReference" : { "type" : "object", "properties" : { "bban" : { "type" : "string" }, "cashAccountType" : { "$ref" : "#/definitions/CashAccountType" }, "currency" : { "type" : "string" }, "iban" : { "type" : "string" }, "maskedPan" : { "type" : "string" }, "msisdn" : { "type" : "string" }, "other" : { "$ref" : "#/definitions/Other" }, "pan" : { "type" : "string" } } }, "v140loansloanaccountid_GET_response" : { "type" : "object", "required" : [ "loanAccount" ], "properties" : { "loanAccount" : { "$ref" : "#/definitions/ResponseAccountDetails" } } }, "Other" : { "type" : "object", "properties" : { "identification" : { "type" : "string" }, "issuer" : { "type" : "string" }, "schemeNameCode" : { "type" : "string" }, "schemeNameProprietary" : { "type" : "string" } } } } }