{ "openapi": "3.0.1", "info": { "title": "AccountOnBoarding API 1.0", "description": "", "contact": { "name": "PayEx" }, "version": "1.0" }, "paths": { "/ledger/account-onboarding/v1/{ownerNo}/offers": { "get": { "tags": [ "AccountOnboarding V2" ], "summary": "List all offers", "description": "List all offers", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.OffersResourceListResult" }, "examples": { "OK": { "description": "Example of response on successfully retrieved offers", "value": "{\r\n \"items\": [\r\n {\r\n \"accountProfile\": \"kontotyp-1\",\r\n \"title\": \"kontotyp 1\",\r\n \"currency\": \"SEK\",\r\n \"maxCreditLimit\": 50000.00,\r\n \"reminderFee\": 35.00,\r\n \"penaltyInterestRate\": 18.00,\r\n \"termsAndConditions\": {\r\n \"standardEuropeanAgreements\": \"https://www.payex.com/term-and-conditions/no/-----.pdf\",\r\n \"accountTerms\": \"https://www.payex.com/term-and-conditions/no/-----.pdf\"\r\n },\r\n \"operations\": []\r\n },\r\n {\r\n \"accountProfile\": \"kontotyp-2\",\r\n \"title\": \"kontotyp 2\",\r\n \"currency\": \"SEK\",\r\n \"maxCreditLimit\": 50000.00,\r\n \"reminderFee\": 35.00,\r\n \"penaltyInterestRate\": 20.00,\r\n \"termsAndConditions\": {\r\n \"standardEuropeanAgreements\": \"https://www.payex.com/term-and-conditions/no/-----.pdf\",\r\n \"accountTerms\": \"https://www.payex.com/term-and-conditions/no/-----.pdf\"\r\n },\r\n \"operations\": []\r\n }\r\n ],\r\n \"navigation\": {\r\n \"@id\": \"/ledger/account-onboarding/v1/xxx/offers\"\r\n }\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "validation": { "description": "occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested profile is not available.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if the validation of the resource's state fails.", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}": { "get": { "tags": [ "AccountOnboarding V2" ], "summary": "View a specific offer", "description": "View a specific offer", "operationId": "PayEx.AR.Api.Resources.AccountOnboarding.V2.Offers.OffersController_Id_GetSingle", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.OffersResource" }, "examples": { "OK": { "description": "Example of response on successfully retrieved offer", "value": "{\r\n \"accountProfile\": \"kontotyp-1\",\r\n \"title\": \"kontotyp 1\",\r\n \"currency\": \"SEK\",\r\n \"maxCreditLimit\": 50000.00,\r\n \"reminderFee\": 35.00,\r\n \"penaltyInterestRate\": 18.00,\r\n \"termsAndConditions\": {\r\n \"standardEuropeanAgreements\": \"https://www.payex.com/term-and-conditions/no/-----.pdf\",\r\n \"accountTerms\": \"https://www.payex.com/term-and-conditions/no/-----.pdf\"\r\n },\r\n \"operations\": []\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "validation": { "description": "occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested profile is not available.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if the validation of the resource's state fails.", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Add application to offer", "description": "Add application to offer", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.ApplicationsResourceBase" }, "example": "{\r\n \"creditLimit\": 5000.00,\r\n \"nationalConsumerIdentifier\": {\r\n \"value\": \"19101010-1010\",\r\n \"countryCode\": \"SE\"\r\n },\r\n \"customerNo\": \"951753456\",\r\n \"emailAddress\": \"test@testshop.se\",\r\n \"msisdn\": \"46701234456\",\r\n \"ipAddress\": \"1.1.1.X\",\r\n \"languageCode\": \"Sv\",\r\n \"specialIntent\": \"new-account-for-invoice-conversion\",\r\n \"applicationOptions\": {\r\n \"customerPreAuthenticated\": false,\r\n \"preAuthorizationAmount\": 5000.00\r\n },\r\n \"sellerNo\": \"123456\",\r\n \"pointOfSale\": \"Example Point of Sale\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.ApplicationsResourceBase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.ApplicationsResourceBase" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.ApplicationsResourceResponse" }, "examples": { "Created": { "description": "Example of response on successfully created application", "value": "{\r\n \"applicationId\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"status\": \"AwaitingSign\",\r\n \"creditLimit\": 5000.00,\r\n \"nationalConsumerIdentifier\": {\r\n \"value\": \"19101010-1010\",\r\n \"countryCode\": \"SE\"\r\n },\r\n \"customerNo\": \"951753456\",\r\n \"emailAddress\": \"test@testshop.se\",\r\n \"msisdn\": \"46701234456\",\r\n \"ipAddress\": \"1.1.1.X\",\r\n \"languageCode\": \"Sv\",\r\n \"specialIntent\": \"new-account-for-invoice-conversion\",\r\n \"applicationOptions\": {\r\n \"customerPreAuthenticated\": false,\r\n \"preAuthorizationAmount\": 5000.00\r\n },\r\n \"sellerNo\": \"123456\",\r\n \"pointOfSale\": \"Example Point of Sale\",\r\n \"kycQuestions\": [\r\n {\r\n \"questionText\": \"What is your current employment?\",\r\n \"answer\": {\r\n \"type\": \"single\",\r\n \"required\": true,\r\n \"possibleAnswers\": [\r\n {\r\n \"answerCode\": \"selfemployed\",\r\n \"answerText\": \"Own business\"\r\n },\r\n {\r\n \"answerCode\": \"private_employee\",\r\n \"answerText\": \"Private employee\"\r\n },\r\n {\r\n \"answerCode\": \"goverment_employee\",\r\n \"answerText\": \"Government employee\"\r\n }\r\n ]\r\n },\r\n \"questionCode\": \"employment\"\r\n },\r\n {\r\n \"questionText\": \"What is your yearly income\",\r\n \"answer\": {\r\n \"type\": \"single\",\r\n \"required\": true,\r\n \"possibleAnswers\": [\r\n {\r\n \"answerCode\": \"incomeinterval1\",\r\n \"answerText\": \"0-100 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval2\",\r\n \"answerText\": \"100 001-200 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval3\",\r\n \"answerText\": \"200 001-300 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval4\",\r\n \"answerText\": \"Over 300 001 SEK\"\r\n }\r\n ]\r\n },\r\n \"questionCode\": \"income\"\r\n }\r\n ],\r\n \"operations\": []\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "customer-mismatch": { "description": "Occurs if the customer NationalIdentifier value doesn't match with the provided CustomerNo value.", "value": "{\r\n \"type\": \"customer-mismatch\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "customer-missing": { "description": "Occurs if the customer with the provided customerNo isn't found and the company doesn't support creating a customer on requested CustomerNo.", "value": "{\r\n \"type\": \"customer-missing\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "account-profile-exists": { "description": "Occurs if an account with the provided accountProfile already exists.", "value": "{\r\n \"type\": \"account-profile-exists\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "account-already-exists-for-standalone-intent": { "description": "Occurs if an active account for the requested account profile already exists for the customer when using a standalone account onboarding intent.", "value": "{\r\n \"type\": \"account-already-exists-for-standalone-intent\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "not-valid-for-intent": { "description": "Occurs if the account profile is not valid for the provided SpecialIntent.", "value": "{\r\n \"type\": \"not-valid-for-intent\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "examples": { "invalid-special-intent": { "description": "Occurs if the provided special intent is invalid.", "value": "{\r\n \"type\": \"invalid-special-intent\",\r\n \"title\": \"Problem title\",\r\n \"status\": 422,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications/{applicationId}": { "get": { "tags": [ "AccountOnboarding V2" ], "summary": "Get existing application", "description": "Get existing application", "operationId": "PayEx.AR.Api.Resources.AccountOnboarding.V2.Offers.Applications.ApplicationsController_Id_GetSingle", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.ApplicationsResourceResponse" }, "examples": { "OK": { "description": "Example of response on successfully retrieved application", "value": "{\r\n \"applicationId\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"status\": \"AwaitingSign\",\r\n \"createdAccount\": {\r\n \"accountNo\": \"1234567\"\r\n },\r\n \"creditLimit\": 5000.00,\r\n \"nationalConsumerIdentifier\": {\r\n \"value\": \"19101010-1010\",\r\n \"countryCode\": \"SE\"\r\n },\r\n \"customerNo\": \"951753456\",\r\n \"emailAddress\": \"test@testshop.se\",\r\n \"msisdn\": \"46701234456\",\r\n \"ipAddress\": \"1.1.1.X\",\r\n \"languageCode\": \"Sv\",\r\n \"specialIntent\": \"new-account-for-invoice-conversion\",\r\n \"applicationOptions\": {\r\n \"customerPreAuthenticated\": false,\r\n \"preAuthorizationAmount\": 5000.00\r\n },\r\n \"sellerNo\": \"123456\",\r\n \"pointOfSale\": \"Example Point of Sale\",\r\n \"kycQuestions\": [\r\n {\r\n \"questionText\": \"What is your current employment?\",\r\n \"answer\": {\r\n \"type\": \"single\",\r\n \"required\": true,\r\n \"possibleAnswers\": [\r\n {\r\n \"answerCode\": \"selfemployed\",\r\n \"answerText\": \"Own business\"\r\n },\r\n {\r\n \"answerCode\": \"private_employee\",\r\n \"answerText\": \"Private employee\"\r\n },\r\n {\r\n \"answerCode\": \"goverment_employee\",\r\n \"answerText\": \"Government employee\"\r\n }\r\n ]\r\n },\r\n \"questionCode\": \"employment\"\r\n },\r\n {\r\n \"questionText\": \"What is your yearly income\",\r\n \"answer\": {\r\n \"type\": \"single\",\r\n \"required\": true,\r\n \"possibleAnswers\": [\r\n {\r\n \"answerCode\": \"incomeinterval1\",\r\n \"answerText\": \"0-100 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval2\",\r\n \"answerText\": \"100 001-200 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval3\",\r\n \"answerText\": \"200 001-300 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval4\",\r\n \"answerText\": \"Over 300 001 SEK\"\r\n }\r\n ]\r\n },\r\n \"questionCode\": \"income\"\r\n }\r\n ],\r\n \"operations\": []\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } }, "patch": { "tags": [ "AccountOnboarding V2" ], "summary": "Update application", "description": "Update application", "operationId": "PayEx.AR.Api.Resources.AccountOnboarding.V2.Offers.Applications.ApplicationsController_Id_Patch", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.ApplicationsResourcePatch" }, "example": "{\r\n \"emailAddress\": \"uppdaterad@test.se\",\r\n \"msisdn\": \"\\u002B456456\",\r\n \"trustedSellerGroupConsents\": [\r\n \"PharmaciesSE\"\r\n ]\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.ApplicationsResourcePatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.ApplicationsResourcePatch" } } } }, "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayEx.LF.Api.Common.RepositoryResources.Results.RepositoryNoContentResult" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "405": { "description": "MethodNotAllowed", "content": { "application/json": { "examples": { "http-method-not-allowed": { "description": "Used HTTP Method was not accepted. Could be because of state or resource or method not implemented", "value": "{\r\n \"type\": \"http-method-not-allowed\",\r\n \"title\": \"Problem title\",\r\n \"status\": 405,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "unexpected-consent": { "description": "Consent was provided when not expected", "value": "{\r\n \"type\": \"unexpected-consent\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications/{applicationId}/kyc-answers": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Submit answers to kyc questions", "description": "Submit answers to kyc questions", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.KycAnswers.KycAnswersResource" }, "example": "{\r\n \"answers\": [\r\n {\r\n \"questionCode\": \"employment\",\r\n \"answerCode\": \"selfemployed\"\r\n },\r\n {\r\n \"questionCode\": \"monthlyincome\",\r\n \"answerCode\": \"monthlyincomeinterval2\"\r\n },\r\n {\r\n \"questionCode\": \"ispep\",\r\n \"answerCode\": \"false\"\r\n }\r\n ]\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.KycAnswers.KycAnswersResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.KycAnswers.KycAnswersResource" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.KycAnswers.KycAnswersResource" }, "examples": { "Created": { "description": "Example of response on successfully created kyc answers", "value": "{\r\n \"answers\": [\r\n {\r\n \"questionCode\": \"employment\",\r\n \"answerCode\": \"selfemployed\"\r\n },\r\n {\r\n \"questionCode\": \"monthlyincome\",\r\n \"answerCode\": \"monthlyincomeinterval2\"\r\n },\r\n {\r\n \"questionCode\": \"ispep\",\r\n \"answerCode\": \"false\"\r\n }\r\n ]\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if the validation of the request fails, it is described in the problem why the input is invalid.", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested resource isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if the validation of the resource's state fails.", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "kyc-not-configured": { "description": "Occurs if the application does not support KYC answers due to the account profile not being configured with any.", "value": "{\r\n \"type\": \"kyc-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } }, "get": { "tags": [ "AccountOnboarding V2" ], "summary": "Get the submited answers to kyc questions", "description": "Get the submited answers to kyc questions", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.KycAnswers.KycAnswersResource" }, "examples": { "OK": { "description": "Example of response on successfully retrieved kyc answers", "value": "{\r\n \"answers\": [\r\n {\r\n \"questionCode\": \"employment\",\r\n \"answerCode\": \"selfemployed\"\r\n },\r\n {\r\n \"questionCode\": \"monthlyincome\",\r\n \"answerCode\": \"monthlyincomeinterval2\"\r\n },\r\n {\r\n \"questionCode\": \"ispep\",\r\n \"answerCode\": \"false\"\r\n }\r\n ]\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested resource isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "kyc-not-configured": { "description": "Occurs if the application does not support KYC answers due to the account profile not being configured with any.", "value": "{\r\n \"type\": \"kyc-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications/{applicationId}/verify-application": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Verify the application", "description": "Verify the application and does a credit check if needed", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.VerifyApplication.VerifyApplicationResourceBase" }, "example": "{}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.VerifyApplication.VerifyApplicationResourceBase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.VerifyApplication.VerifyApplicationResourceBase" } } } }, "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayEx.LF.Api.Common.RepositoryResources.Results.RepositoryNoContentResult" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "examples": { "credit-check-declined": { "description": "Occurs if the credit check is denied.", "value": "{\r\n \"type\": \"credit-check-declined\",\r\n \"title\": \"Problem title\",\r\n \"status\": 422,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications/{applicationId}/approve-paper-application": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Approve a paper application", "description": "Approves a paper onboarding application by performing a credit check, creating the customer and account, and archiving the scanned application document. Used exclusively for the standalone-account-onboarding-manual intent via Effecte.", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.ApprovePaperApplication.ApprovePaperApplicationRequest" }, "example": "{\r\n \"applicationDocument\": {\r\n \"content\": \"JVBERi0xLjQKJ...\",\r\n \"fileType\": \"pdf\"\r\n },\r\n \"trusteeCertificateIncluded\": false\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.ApprovePaperApplication.ApprovePaperApplicationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.ApprovePaperApplication.ApprovePaperApplicationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.ApprovePaperApplication.ApprovePaperApplicationResponse" }, "examples": { "OK": { "description": "Example of response on successfully approved paper application", "value": "{\r\n \"accountNo\": \"1234567\",\r\n \"customerNo\": \"951753456\"\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if any of the input validation fails.", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "not-valid-for-intent": { "description": "Occurs if the application was not created with the standalone-account-onboarding-manual intent.", "value": "{\r\n \"type\": \"not-valid-for-intent\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "invalid-application-state": { "description": "Occurs if the application is not in AwaitingSign state.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "examples": { "credit-check-declined": { "description": "Occurs if the credit check was denied. Application status is set to Rejected.", "value": "{\r\n \"type\": \"credit-check-declined\",\r\n \"title\": \"Problem title\",\r\n \"status\": 422,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications/{applicationId}/sign-bankid-se": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Initiate bankid signing process", "description": "Initiate bankid signing process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.SignBankidSe.SignBankidSeResourceRequest" }, "example": "{\r\n \"endUserIp\": \"194.168.2.25\",\r\n \"callbackUrl\": \"https://myCallbackUrl\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.SignBankidSe.SignBankidSeResourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.SignBankidSe.SignBankidSeResourceRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.SignBankidSe.SignBankidSeResource" }, "examples": { "Created": { "description": "Example of response on successfully created sign bankid se. The signing process is carried out in a background process even after the response is returned.", "value": "{\r\n \"autostartToken\": \"7c40b5c9-fa74-49cf-b98c-bfe651f9a7c6\",\r\n \"qrCodeImageDataUrl\": \"data:image/png;base64,VeryLongBase64String\",\r\n \"status\": \"Pending\",\r\n \"hintCode\": \"OutstandingTransaction\",\r\n \"maxExtends\": 0,\r\n \"currentExtend\": 0,\r\n \"secondsLeftThirtySecondsInterval\": 0,\r\n \"endUserIp\": \"194.168.2.25\",\r\n \"callbackUrl\": \"https://myCallbackUrl\",\r\n \"operations\": []\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "company-not-configured": { "description": "Occurs when operations is not supported with the ledger current configuration. This configuration may or may not be immutable.", "value": "{\r\n \"type\": \"company-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } }, "get": { "tags": [ "AccountOnboarding V2" ], "summary": "Retrieve bankid signing process data", "description": "Retrieve bankid signing process data", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.SignBankidSe.SignBankidSeResource" }, "examples": { "OK": { "description": "Example of response on successfully retrieved sign bankid se. This should be polled. The resource is updated in the signing process running in the background.", "value": "{\r\n \"autostartToken\": \"7c40b5c9-fa74-49cf-b98c-bfe651f9a7c6\",\r\n \"qrCodeImageDataUrl\": \"data:image/png;base64,VeryLongBase64String\",\r\n \"status\": \"Pending\",\r\n \"hintCode\": \"OutstandingTransaction\",\r\n \"maxExtends\": 0,\r\n \"currentExtend\": 0,\r\n \"secondsLeftThirtySecondsInterval\": 0,\r\n \"endUserIp\": \"194.168.2.25\",\r\n \"callbackUrl\": \"https://myCallbackUrl\",\r\n \"operations\": []\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested resource isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications/{applicationId}/sign-bankid-se/cancel": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Cancel bankid signing process", "description": "Cancel bankid signing process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.SignBankidSe.Operations.CancelResourceRequest" }, "example": "{}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.SignBankidSe.Operations.CancelResourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.SignBankidSe.Operations.CancelResourceRequest" } } } }, "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayEx.LF.Api.Common.RepositoryResources.Results.RepositoryNoContentResult" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "invalid-bank-id-state": { "description": "Occurs if the bankId state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-bank-id-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications/{applicationId}/sign-bankid-se/extend": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Extend bankid signing process", "description": "Extend the time period for an ongoing bankid signing process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.SingleResources.SignBankidSe.Operations.ExtendResource" }, "examples": { "OK": { "description": "Example of a response where Extend has been called once before (currentExtend 1), and some time has elapsed (90 seconds left).", "value": "{\r\n \"maxExtends\": 10,\r\n \"currentExtend\": 1,\r\n \"secondsLeftThirtySecondsInterval\": 90\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "conflict": { "description": "Occurs if the application state is invalid, see message for details.", "value": "{\r\n \"type\": \"conflict\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem.", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-applications": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Add limit upgrade application", "description": "Add limit upgrade application", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.LimitUpgradeApplicationsResourceBase" }, "example": "{\r\n \"creditLimit\": 5000.00,\r\n \"accountNo\": \"123456\",\r\n \"languageCode\": \"Sv\",\r\n \"specialIntent\": \"limit-upgrade-for-invoice-conversion\",\r\n \"applicationOptions\": {\r\n \"customerPreAuthenticated\": false,\r\n \"preAuthorizationAmount\": 5000.00\r\n }\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.LimitUpgradeApplicationsResourceBase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.LimitUpgradeApplicationsResourceBase" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.LimitUpgradeApplicationsResourceResponse" }, "examples": { "Created": { "description": "Example of response on successfully created limit upgrade application", "value": "{\r\n \"limitUpgradeApplicationId\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"status\": \"AwaitingSign\",\r\n \"creditLimit\": 5000.00,\r\n \"accountNo\": \"123456\",\r\n \"languageCode\": \"Sv\",\r\n \"specialIntent\": \"limit-upgrade-for-invoice-conversion\",\r\n \"applicationOptions\": {\r\n \"customerPreAuthenticated\": false,\r\n \"preAuthorizationAmount\": 5000.00\r\n },\r\n \"kycQuestions\": [\r\n {\r\n \"questionText\": \"What is your current employment?\",\r\n \"answer\": {\r\n \"type\": \"single\",\r\n \"required\": true,\r\n \"possibleAnswers\": [\r\n {\r\n \"answerCode\": \"selfemployed\",\r\n \"answerText\": \"Own business\"\r\n },\r\n {\r\n \"answerCode\": \"private_employee\",\r\n \"answerText\": \"Private employee\"\r\n },\r\n {\r\n \"answerCode\": \"goverment_employee\",\r\n \"answerText\": \"Government employee\"\r\n }\r\n ]\r\n },\r\n \"questionCode\": \"employment\"\r\n },\r\n {\r\n \"questionText\": \"What is your yearly income\",\r\n \"answer\": {\r\n \"type\": \"single\",\r\n \"required\": true,\r\n \"possibleAnswers\": [\r\n {\r\n \"answerCode\": \"incomeinterval1\",\r\n \"answerText\": \"0-100 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval2\",\r\n \"answerText\": \"100 001-200 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval3\",\r\n \"answerText\": \"200 001-300 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval4\",\r\n \"answerText\": \"Over 300 001 SEK\"\r\n }\r\n ]\r\n },\r\n \"questionCode\": \"income\"\r\n }\r\n ],\r\n \"operations\": []\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested resource isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if a valid account is not available.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "account-status": { "description": "Occurs if the account status is invalid for the request to be made.", "value": "{\r\n \"type\": \"account-status\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "credit-limit-already-sufficient": { "description": "Occurs if the requested credit limit is invalid because it is already sufficient.", "value": "{\r\n \"type\": \"credit-limit-already-sufficient\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "examples": { "invalid-special-intent": { "description": "Occurs if the provided special intent is invalid.", "value": "{\r\n \"type\": \"invalid-special-intent\",\r\n \"title\": \"Problem title\",\r\n \"status\": 422,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-applications/{limitUpgradeApplicationId}": { "get": { "tags": [ "AccountOnboarding V2" ], "summary": "Get existing limit upgrade application", "description": "Get existing limit upgrade application", "operationId": "PayEx.AR.Api.Resources.AccountOnboarding.V2.LimitUpgradeApplications.LimitUpgradeApplicationsController_Id_GetSingle", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.LimitUpgradeApplicationsResourceResponse" }, "examples": { "OK": { "description": "Example of response on successfully created limit upgrade application", "value": "{\r\n \"limitUpgradeApplicationId\": \"123e4567-e89b-12d3-a456-426614174000\",\r\n \"status\": \"AwaitingSign\",\r\n \"creditLimit\": 5000.00,\r\n \"accountNo\": \"123456\",\r\n \"languageCode\": \"Sv\",\r\n \"specialIntent\": \"limit-upgrade-for-invoice-conversion\",\r\n \"applicationOptions\": {\r\n \"customerPreAuthenticated\": false,\r\n \"preAuthorizationAmount\": 5000.00\r\n },\r\n \"kycQuestions\": [\r\n {\r\n \"questionText\": \"What is your current employment?\",\r\n \"answer\": {\r\n \"type\": \"single\",\r\n \"required\": true,\r\n \"possibleAnswers\": [\r\n {\r\n \"answerCode\": \"selfemployed\",\r\n \"answerText\": \"Own business\"\r\n },\r\n {\r\n \"answerCode\": \"private_employee\",\r\n \"answerText\": \"Private employee\"\r\n },\r\n {\r\n \"answerCode\": \"goverment_employee\",\r\n \"answerText\": \"Government employee\"\r\n }\r\n ]\r\n },\r\n \"questionCode\": \"employment\"\r\n },\r\n {\r\n \"questionText\": \"What is your yearly income\",\r\n \"answer\": {\r\n \"type\": \"single\",\r\n \"required\": true,\r\n \"possibleAnswers\": [\r\n {\r\n \"answerCode\": \"incomeinterval1\",\r\n \"answerText\": \"0-100 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval2\",\r\n \"answerText\": \"100 001-200 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval3\",\r\n \"answerText\": \"200 001-300 000 SEK\"\r\n },\r\n {\r\n \"answerCode\": \"incomeinterval4\",\r\n \"answerText\": \"Over 300 001 SEK\"\r\n }\r\n ]\r\n },\r\n \"questionCode\": \"income\"\r\n }\r\n ],\r\n \"operations\": []\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested resource isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-applications/{limitUpgradeApplicationId}/kyc-answers": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Submit answers to kyc questions", "description": "Submit answers to kyc questions", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.KycAnswers.KycAnswersResource" }, "example": "{\r\n \"answers\": [\r\n {\r\n \"questionCode\": \"employment\",\r\n \"answerCode\": \"selfemployed\"\r\n },\r\n {\r\n \"questionCode\": \"monthlyincome\",\r\n \"answerCode\": \"monthlyincomeinterval2\"\r\n },\r\n {\r\n \"questionCode\": \"ispep\",\r\n \"answerCode\": \"false\"\r\n }\r\n ]\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.KycAnswers.KycAnswersResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.KycAnswers.KycAnswersResource" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.KycAnswers.KycAnswersResource" }, "examples": { "Created": { "description": "Example of response on successfully created kyc answers", "value": "{\r\n \"answers\": [\r\n {\r\n \"questionCode\": \"employment\",\r\n \"answerCode\": \"selfemployed\"\r\n },\r\n {\r\n \"questionCode\": \"monthlyincome\",\r\n \"answerCode\": \"monthlyincomeinterval2\"\r\n },\r\n {\r\n \"questionCode\": \"ispep\",\r\n \"answerCode\": \"false\"\r\n }\r\n ]\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested resource isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if the validation of the resource's state fails.", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "kyc-not-configured": { "description": "Occurs if the application does not support KYC answers due to the account profile not being configured with any.", "value": "{\r\n \"type\": \"kyc-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } }, "get": { "tags": [ "AccountOnboarding V2" ], "summary": "Get the submited answers to kyc questions", "description": "Get the submited answers to kyc questions", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.KycAnswers.KycAnswersResource" }, "examples": { "OK": { "description": "Example of response on successfully retrieved kyc answers", "value": "{\r\n \"answers\": [\r\n {\r\n \"questionCode\": \"employment\",\r\n \"answerCode\": \"selfemployed\"\r\n },\r\n {\r\n \"questionCode\": \"monthlyincome\",\r\n \"answerCode\": \"monthlyincomeinterval2\"\r\n },\r\n {\r\n \"questionCode\": \"ispep\",\r\n \"answerCode\": \"false\"\r\n }\r\n ]\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested resource isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "kyc-not-configured": { "description": "Occurs if the application does not support KYC answers due to the account profile not being configured with any.", "value": "{\r\n \"type\": \"kyc-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-applications/{limitUpgradeApplicationId}/verify-application": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Verify the application", "description": "Verify the application and does a credit check if needed", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.VerifyApplication.VerifyApplicationResourceBase" }, "example": "{}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.VerifyApplication.VerifyApplicationResourceBase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.VerifyApplication.VerifyApplicationResourceBase" } } } }, "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayEx.LF.Api.Common.RepositoryResources.Results.RepositoryNoContentResult" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "examples": { "credit-check-declined": { "description": "Occurs if the credit check is denied.", "value": "{\r\n \"type\": \"credit-check-declined\",\r\n \"title\": \"Problem title\",\r\n \"status\": 422,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications/{applicationId}/begin-sign-bankid-no": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Initiate Norwegain bankid signing process", "description": "Initiate Norwegain bankid signing process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.BeginSignBankidNo.BeginSignBankidNoRequest" }, "example": "{\r\n \"completeUrl\": \"https://sucessful-page?id=123\",\r\n \"cancelUrl\": \"https://unsucessful-page?id=123\",\r\n \"callbackUrl\": \"https://my-callback-url?id=123\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.BeginSignBankidNo.BeginSignBankidNoRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.BeginSignBankidNo.BeginSignBankidNoRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.BeginSignBankidNo.BeginSignBankidNoResponse" }, "examples": { "OK": { "description": "Example of successful response. This response has started a background process that begin polling for update about the signing for a limited time.", "value": "{\r\n \"signingUrl\": \"https://example-signicat.com/std/docaction/profile-identify?request_id=123456abcdefg\"\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "company-not-configured": { "description": "Occurs when operations is not supported with the ledger current configuration. This configuration may or may not be immutable.", "value": "{\r\n \"type\": \"company-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-applications/{limitUpgradeApplicationId}/begin-sign-bankid-no": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Initiate Norwegain bankid signing process", "description": "Initiate Norwegain bankid signing process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.BeginSignBankidNo.BeginSignBankidNoRequest" }, "example": "{\r\n \"completeUrl\": \"https://sucessful-page?id=123\",\r\n \"cancelUrl\": \"https://unsucessful-page?id=123\",\r\n \"callbackUrl\": \"https://my-callback-url?id=123\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.BeginSignBankidNo.BeginSignBankidNoRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.BeginSignBankidNo.BeginSignBankidNoRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.BeginSignBankidNo.BeginSignBankidNoResponse" }, "examples": { "OK": { "description": "Example of successful response. This response has started a background process that begin polling for update about the signing for a limited time.", "value": "{\r\n \"signingUrl\": \"https://example-signicat.com/std/docaction/profile-identify?request_id=123456abcdefg\"\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "company-not-configured": { "description": "Occurs when operations is not supported with the ledger current configuration. This configuration may or may not be immutable.", "value": "{\r\n \"type\": \"company-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-applications/{limitUpgradeApplicationId}/sign-bankid-se": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Initiate bankid signing process", "description": "Initiate bankid signing process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.SignBankidSe.SignBankidSeResourceRequest" }, "example": "{\r\n \"endUserIp\": \"194.168.2.25\",\r\n \"callbackUrl\": \"https://myCallbackUrl\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.SignBankidSe.SignBankidSeResourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.SignBankidSe.SignBankidSeResourceRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.SignBankidSe.SignBankidSeResource" }, "examples": { "Created": { "description": "Example of response on successfully created sign bankid se. The signing process is carried out in a background process even after the response is returned.", "value": "{\r\n \"autostartToken\": \"7c40b5c9-fa74-49cf-b98c-bfe651f9a7c6\",\r\n \"qrCodeImageDataUrl\": \"data:image/png;base64,VeryLongBase64String\",\r\n \"status\": \"Pending\",\r\n \"hintCode\": \"OutstandingTransaction\",\r\n \"maxExtends\": 0,\r\n \"currentExtend\": 0,\r\n \"secondsLeftThirtySecondsInterval\": 0,\r\n \"endUserIp\": \"194.168.2.25\",\r\n \"callbackUrl\": \"https://myCallbackUrl\",\r\n \"operations\": []\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "company-not-configured": { "description": "Occurs when operations is not supported with the ledger current configuration. This configuration may or may not be immutable.", "value": "{\r\n \"type\": \"company-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } }, "get": { "tags": [ "AccountOnboarding V2" ], "summary": "Retrieve bankid signing process data", "description": "Retrieve bankid signing process data", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.SignBankidSe.SignBankidSeResource" }, "examples": { "OK": { "description": "Example of response on successfully retrieved sign bankid se. This should be polled. The resource is updated in the signing process running in the background.", "value": "{\r\n \"autostartToken\": \"7c40b5c9-fa74-49cf-b98c-bfe651f9a7c6\",\r\n \"qrCodeImageDataUrl\": \"data:image/png;base64,VeryLongBase64String\",\r\n \"status\": \"Pending\",\r\n \"hintCode\": \"OutstandingTransaction\",\r\n \"maxExtends\": 0,\r\n \"currentExtend\": 0,\r\n \"secondsLeftThirtySecondsInterval\": 0,\r\n \"endUserIp\": \"194.168.2.25\",\r\n \"callbackUrl\": \"https://myCallbackUrl\",\r\n \"operations\": []\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested resource isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications/{applicationId}/begin-sign-mitid-dk": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Initiate Danish mitid signing process", "description": "Initiate Danish mitid signing process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.BeginSignMitidDk.BeginSignMitidDkRequest" }, "example": "{}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.BeginSignMitidDk.BeginSignMitidDkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.BeginSignMitidDk.BeginSignMitidDkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.BeginSignMitidDk.BeginSignMitidDkResponse" }, "examples": { "OK": { "description": "Example of successful response. This response has started a background process that begins polling for update about the signing for a limited time.", "value": "{}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "company-not-configured": { "description": "Occurs when operations is not supported with the ledger current configuration. This configuration may or may not be immutable.", "value": "{\r\n \"type\": \"company-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-applications/{limitUpgradeApplicationId}/begin-sign-mitid-dk": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Initiate Danish mitid signing process", "description": "Initiate Danish mitid signing process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.BeginSignMitidDk.BeginSignMitidDkRequest" }, "example": "{}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.BeginSignMitidDk.BeginSignMitidDkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.BeginSignMitidDk.BeginSignMitidDkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.BeginSignMitidDk.BeginSignMitidDkResponse" }, "examples": { "OK": { "description": "Example of successful response. This response has started a background process that begins polling for update about the signing for a limited time.", "value": "{}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "Occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "company-not-configured": { "description": "Occurs when operations is not supported with the ledger current configuration. This configuration may or may not be immutable.", "value": "{\r\n \"type\": \"company-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/applications/{applicationId}/redirect-kalp-dk": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Initiate the Danish KALP process", "description": "Creates or gets a url for the Kalp page that the customer need to fill out to continue the application process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.RedirectKalpDk.RedirectKalpDkRequest" }, "example": "{}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.RedirectKalpDk.RedirectKalpDkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.RedirectKalpDk.RedirectKalpDkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Applications.Operations.RedirectKalpDk.RedirectKalpDkResponse" }, "examples": { "Example of a response from the Application RedirectKalpDk operation": { "value": "{\r\n \"redirectUrl\": \"https://flow.monthio.com/?sessionId=kalpid\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "conflict": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"conflict\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "company-not-configured": { "description": "Occurs when operations is not supported with the ledger current configuration. This configuration may or may not be immutable.", "value": "{\r\n \"type\": \"company-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "kalp-not-configured": { "description": "Occurs when account profile is not configured for Kalp.", "value": "{\r\n \"type\": \"kalp-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-applications/{limitUpgradeApplicationId}/redirect-kalp-dk": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Initiate the Danish KALP process", "description": "Creates or gets a url for the Kalp page that the customer need to fill out to continue the limit upgrade application process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.RedirectKalpDk.RedirectKalpDkRequest" }, "example": "{}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.RedirectKalpDk.RedirectKalpDkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.RedirectKalpDk.RedirectKalpDkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.Operations.RedirectKalpDk.RedirectKalpDkResponse" }, "examples": { "OK": { "description": "Example of a response from the Limit Upgrade Application RedirectKalpDk operation", "value": "{\r\n \"redirectUrl\": \"https://flow.monthio.com/?sessionId=kalpid\"\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "conflict": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"conflict\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "company-not-configured": { "description": "Occurs when operations is not supported with the ledger current configuration. This configuration may or may not be immutable.", "value": "{\r\n \"type\": \"company-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "kalp-not-configured": { "description": "Occurs when account profile is not configured for Kalp.", "value": "{\r\n \"type\": \"kalp-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-applications/{limitUpgradeApplicationId}/sign-bankid-se/cancel": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Cancel bankid signing process", "description": "Cancel bankid signing process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.SignBankidSe.Operations.Cancel.CancelResourceRequest" }, "example": "{}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.SignBankidSe.Operations.Cancel.CancelResourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.SignBankidSe.Operations.Cancel.CancelResourceRequest" } } } }, "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayEx.LF.Api.Common.RepositoryResources.Results.RepositoryNoContentResult" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "invalid-application-state": { "description": "Occurs if the application state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-application-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "invalid-bank-id-state": { "description": "Occurs if the bankId state is invalid for the request to be made.", "value": "{\r\n \"type\": \"invalid-bank-id-state\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-applications/{limitUpgradeApplicationId}/sign-bankid-se/extend": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Extend bankid signing process", "description": "Extend the time period for an ongoing bankid signing process", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limitUpgradeApplicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeApplications.SingleResources.SignBankidSe.Operations.Extend.ExtendResource" }, "examples": { "OK": { "description": "Example of a response where Extend has been called once before (currentExtend 1), and some time has elapsed (90 seconds left).", "value": "{\r\n \"maxExtends\": 10,\r\n \"currentExtend\": 1,\r\n \"secondsLeftThirtySecondsInterval\": 90\r\n}" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "examples": { "not-found": { "description": "Occurs if the requested application isn't found.", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "resource-unavailable": { "description": "Occurs if the requested resource is unavailable when retrieving it from the cache.", "value": "{\r\n \"type\": \"resource-unavailable\",\r\n \"title\": \"Problem title\",\r\n \"status\": 404,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "conflict": { "description": "Occurs if the application state is invalid, see message for details.", "value": "{\r\n \"type\": \"conflict\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem.", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/offers/{accountProfile}/create-account-without-application": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "create an account without application", "description": "Create a new account for a consumer, with the selected offer. Only one account i permitted for a combination of consumer and offer", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountProfile", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Operations.CreateAccountWithoutApplication.CreateAccountWithoutApplicationResourceBase" }, "example": "{\r\n \"customerNo\": \"951753456\",\r\n \"creditLimit\": 5000.00\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Operations.CreateAccountWithoutApplication.CreateAccountWithoutApplicationResourceBase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Operations.CreateAccountWithoutApplication.CreateAccountWithoutApplicationResourceBase" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.Offers.Operations.CreateAccountWithoutApplication.CreateAccountWithoutApplicationResourceResponse" }, "examples": { "OK": { "description": "Example of response on successfully created account.", "value": "{\r\n \"accountNo\": \"123456\",\r\n \"customerNo\": \"951753456\",\r\n \"creditLimit\": 5000.00\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "not-found": { "description": "occurs if the customer supplied does not exist", "value": "{\r\n \"type\": \"not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } }, "/ledger/account-onboarding/v1/{ownerNo}/limit-upgrade-without-application": { "post": { "tags": [ "AccountOnboarding V2" ], "summary": "Upgrade account limit without application", "description": "Update limit for a account, it's possible to both lower and increase the amount.", "parameters": [ { "name": "ownerNo", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeWithoutApplication.LimitUpgradeWithoutApplicationResourceBase" }, "example": "{\r\n \"accountNo\": \"123456\",\r\n \"creditLimit\": 5000.00\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeWithoutApplication.LimitUpgradeWithoutApplicationResourceBase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeWithoutApplication.LimitUpgradeWithoutApplicationResourceBase" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2.LimitUpgradeWithoutApplication.LimitUpgradeWithoutApplicationResourceResponse" }, "examples": { "OK": { "description": "Example of response on successfully updated account limit.", "value": "{\r\n \"accountNo\": \"123456\",\r\n \"creditLimit\": 5000.00\r\n}" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "examples": { "validation": { "description": "occurs if any of the input validation fails, it is described in the problem which parameter that failed the validation", "value": "{\r\n \"type\": \"validation\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" }, "account-name-not-found": { "description": "occurs if account isn't found.", "value": "{\r\n \"type\": \"account-name-not-found\",\r\n \"title\": \"Problem title\",\r\n \"status\": 400,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "examples": { "company-not-configured": { "description": "occurs if company supplied isn't configured", "value": "{\r\n \"type\": \"company-not-configured\",\r\n \"title\": \"Problem title\",\r\n \"status\": 409,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "examples": { "fatal": { "description": "Unexpected error, logs may give details about the problem", "value": "{\r\n \"type\": \"fatal\",\r\n \"title\": \"Problem title\",\r\n \"status\": 500,\r\n \"detail\": \"Problem details\",\r\n \"instance\": \"/traceId/e7e47c48-4a22-426e-9746-0dc0ea21d73a\"\r\n}" } } } } } } } } }, "components": { "schemas": { "PayEx.AR.BankID.Client.Entities.HintCode": { "enum": [ "None", "OutstandingTransaction", "NoClient", "Started", "UserMrtd", "UserCallConfirm", "UserSign", "ExpiredTransaction", "CertificateErr", "UserCancel", "Cancelled", "StartFailed", "UserDeclinedCall" ], "type": "integer", "format": "int32" }, "PayEx.AR.BankID.Client.Entities.Status": { "enum": [ "Pending", "Complete", "Failed" ], "type": "integer", "format": "int32" }, "PayEx.LF.Api.Common.RepositoryResources.IOperation": { "type": "object", "properties": { "rel": { "type": "string", "nullable": true, "readOnly": true }, "method": { "type": "string", "nullable": true, "readOnly": true }, "href": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PayEx.LF.Api.Common.RepositoryResources.NavigationView": { "required": [ "@id", "first", "next", "previous" ], "type": "object", "properties": { "@id": { "minLength": 1, "type": "string", "description": "The current result view.", "format": "uri" }, "first": { "minLength": 1, "type": "string", "description": "Link to the first results.", "format": "uri" }, "previous": { "minLength": 1, "type": "string", "description": "Link to the previous results.", "format": "uri" }, "next": { "minLength": 1, "type": "string", "description": "Link to the next results.", "format": "uri" } }, "additionalProperties": false }, "PayEx.LF.Api.Common.RepositoryResources.Results.RepositoryNoContentResult": { "type": "object", "additionalProperties": false }, "V2.Answer": { "required": [ "answerCode", "questionCode" ], "type": "object", "properties": { "questionCode": { "minLength": 1, "type": "string", "description": "The code definition of the question" }, "answerCode": { "minLength": 1, "type": "string", "description": "The code definition of the answer" } }, "additionalProperties": false }, "V2.AnswerBase": { "required": [ "possibleAnswers", "required", "textValidationRegEx", "type" ], "type": "object", "properties": { "type": { "minLength": 1, "type": "string", "description": "The type of the expected answer: single | multi | text" }, "required": { "type": "boolean", "description": "If the answer is required" }, "textValidationRegEx": { "minLength": 1, "type": "string", "description": "The regex the answer should match" }, "possibleAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/V2.PossibleAnswer" }, "description": "The definitions of possible answers" } }, "additionalProperties": false }, "V2.ApplicationOptions": { "type": "object", "properties": { "customerPreAuthenticated": { "type": "boolean", "description": "Optional flag used when the customer is pre-authenticated. Defaults to false" }, "preAuthorizationAmount": { "type": "number", "description": "Optional field to support including information about the expected authorization amount in junction with the onboarding. The inclusion of this value may differ based fom company configurations.", "format": "double", "nullable": true } }, "additionalProperties": false }, "V2.Currency": { "enum": [ "None", "SEK", "NOK", "DKK", "EUR" ], "type": "string" }, "V2.LanguageCode": { "enum": [ "None", "Sv", "En", "No", "Da" ], "type": "string" }, "V2.LimitUpgradeApplications.LimitUpgradeApplicationsResourceBase": { "required": [ "accountNo", "creditLimit", "languageCode" ], "type": "object", "properties": { "@id": { "type": "string", "nullable": true }, "creditLimit": { "maximum": 100000000, "minimum": 0.01, "pattern": "^\\d+.?(\\d{1,2})?$", "type": "number", "description": "Credit limit on account applied for, can't have more than 2 decimal places", "format": "double" }, "accountNo": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The identifier of the account" }, "ipAddress": { "maxLength": 43, "pattern": "[a-z0-9.:/]*", "type": "string", "description": "Senders ip address", "nullable": true }, "languageCode": { "$ref": "#/components/schemas/V2.LanguageCode" }, "specialIntent": { "type": "string", "description": "Optional instruction used in special cases. Possible values (IncreaseLimitForInvoiceConversion)", "nullable": true }, "applicationOptions": { "$ref": "#/components/schemas/V2.ApplicationOptions" } }, "additionalProperties": false }, "V2.LimitUpgradeApplications.LimitUpgradeApplicationsResourceResponse": { "required": [ "accountNo", "creditLimit", "languageCode" ], "type": "object", "properties": { "@id": { "type": "string", "nullable": true }, "creditLimit": { "maximum": 100000000, "minimum": 0.01, "pattern": "^\\d+.?(\\d{1,2})?$", "type": "number", "description": "Credit limit on account applied for, can't have more than 2 decimal places", "format": "double" }, "accountNo": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The identifier of the account" }, "ipAddress": { "maxLength": 43, "pattern": "[a-z0-9.:/]*", "type": "string", "description": "Senders ip address", "nullable": true }, "languageCode": { "$ref": "#/components/schemas/V2.LanguageCode" }, "specialIntent": { "type": "string", "description": "Optional instruction used in special cases. Possible values (IncreaseLimitForInvoiceConversion)", "nullable": true }, "applicationOptions": { "$ref": "#/components/schemas/V2.ApplicationOptions" }, "limitUpgradeApplicationId": { "type": "string", "description": "LimitUpgradeApplicationId", "nullable": true }, "status": { "$ref": "#/components/schemas/V2.Status" }, "kycAnswers": { "description": "The kyc resource", "nullable": true }, "signBankidSe": { "description": "The sign bankid se resource", "nullable": true }, "kycQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/V2.Question" }, "description": "kyc (know your customer). The questions and answers in the example are just examples of what it might look like. ", "nullable": true }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/PayEx.LF.Api.Common.RepositoryResources.IOperation" }, "nullable": true } }, "additionalProperties": false }, "V2.LimitUpgradeApplications.Operations.BeginSignBankidNo.BeginSignBankidNoRequest": { "type": "object", "properties": { "completeUrl": { "maxLength": 2048, "type": "string", "description": "Url to redirect the user from Signicat Signing when signing has been completed", "nullable": true }, "cancelUrl": { "maxLength": 2048, "type": "string", "description": "Url to redirect the user from Signicat Signing when user choose to cancel the ongoing signing", "nullable": true }, "callbackUrl": { "type": "string", "description": "Specify a callback url that will be called to notify about status change. If empty no callback is done. Supported HTTP request methods [GET]", "nullable": true } }, "additionalProperties": false }, "V2.LimitUpgradeApplications.Operations.BeginSignBankidNo.BeginSignBankidNoResponse": { "type": "object", "properties": { "signingUrl": { "type": "string", "description": "Url to Signicat Signing. The url to the signing order can be signed by who ever has Norwegian BankId so be sure it's the customer of the account that signs else the onboarding will fail later on", "nullable": true } }, "additionalProperties": false }, "V2.LimitUpgradeApplications.Operations.BeginSignMitidDk.BeginSignMitidDkRequest": { "type": "object", "properties": { "completeUrl": { "maxLength": 2048, "type": "string", "description": "Url to redirect the user from Signicat Signing when signing has been completed", "nullable": true }, "cancelUrl": { "maxLength": 2048, "type": "string", "description": "Url to redirect the user from Signicat Signing when user choose to cancel the ongoing signing", "nullable": true }, "callbackUrl": { "type": "string", "description": "Specify a callback url that will be called to notify about status change. If empty no callback is done. Supported HTTP request methods [GET]", "nullable": true } }, "additionalProperties": false }, "V2.LimitUpgradeApplications.Operations.BeginSignMitidDk.BeginSignMitidDkResponse": { "type": "object", "properties": { "signingUrl": { "type": "string", "description": "Url to Signicat Signing. The url to the signing order can be signed by who ever has Danish BankId so be sure it's the customer of the account that signs else the onboarding will fail later on", "nullable": true } }, "additionalProperties": false }, "V2.LimitUpgradeApplications.Operations.RedirectKalpDk.RedirectKalpDkRequest": { "type": "object", "additionalProperties": false }, "V2.LimitUpgradeApplications.Operations.RedirectKalpDk.RedirectKalpDkResponse": { "type": "object", "properties": { "redirectUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "V2.LimitUpgradeApplications.Operations.VerifyApplication.VerifyApplicationResourceBase": { "type": "object", "additionalProperties": false }, "V2.LimitUpgradeApplications.SingleResources.KycAnswers.KycAnswersResource": { "required": [ "answers" ], "type": "object", "properties": { "@id": { "type": "string", "nullable": true }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/V2.Answer" }, "description": "The answers to corresponding questions" } }, "additionalProperties": false }, "V2.LimitUpgradeApplications.SingleResources.SignBankidSe.Operations.Cancel.CancelResourceRequest": { "type": "object", "additionalProperties": false }, "V2.LimitUpgradeApplications.SingleResources.SignBankidSe.Operations.Extend.ExtendResource": { "type": "object", "properties": { "maxExtends": { "type": "integer", "format": "int32" }, "currentExtend": { "type": "integer", "format": "int32" }, "secondsLeftThirtySecondsInterval": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "V2.LimitUpgradeApplications.SingleResources.SignBankidSe.SignBankidSeResource": { "required": [ "endUserIp" ], "type": "object", "properties": { "@id": { "type": "string", "nullable": true }, "endUserIp": { "minLength": 1, "type": "string", "description": "IP address of the end user." }, "callbackUrl": { "type": "string", "description": "If callback should be done on status change, it is done to the callback url. If empty no callback is done.", "nullable": true }, "autostartToken": { "type": "string", "description": "Autostart token to start BankId on the device client's current device.", "format": "uuid" }, "qrCodeImageDataUrl": { "type": "string", "description": "QR code in Base64 that the end user needs to scan on another device than the one used to initiate.", "nullable": true }, "status": { "$ref": "#/components/schemas/PayEx.AR.BankID.Client.Entities.Status" }, "hintCode": { "$ref": "#/components/schemas/PayEx.AR.BankID.Client.Entities.HintCode" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/PayEx.LF.Api.Common.RepositoryResources.IOperation" }, "nullable": true }, "maxExtends": { "type": "integer", "description": "Maximum Extend operation calls that are allowed.", "format": "int32" }, "currentExtend": { "type": "integer", "description": "The amount of extend operations that have been made on this resource.", "format": "int32" }, "secondsLeftThirtySecondsInterval": { "type": "integer", "description": "Time left in seconds for end user to complete signing. Only updated every 30 seconds.", "format": "int32" } }, "additionalProperties": false }, "V2.LimitUpgradeApplications.SingleResources.SignBankidSe.SignBankidSeResourceRequest": { "required": [ "endUserIp" ], "type": "object", "properties": { "@id": { "type": "string", "nullable": true }, "endUserIp": { "minLength": 1, "type": "string", "description": "IP address of the end user." }, "callbackUrl": { "type": "string", "description": "If callback should be done on status change, it is done to the callback url. If empty no callback is done.", "nullable": true } }, "additionalProperties": false }, "V2.LimitUpgradeWithoutApplication.LimitUpgradeWithoutApplicationResourceBase": { "required": [ "accountNo", "creditLimit" ], "type": "object", "properties": { "@id": { "type": "string", "nullable": true }, "accountNo": { "minLength": 1, "type": "string", "description": "The identifier of the account" }, "creditLimit": { "maximum": 100000000, "minimum": 0, "pattern": "^\\d+.?(\\d{1,2})?$", "type": "number", "description": "Credit limit on account applied for, can't have more than 2 decimal places", "format": "double" } }, "additionalProperties": false }, "V2.LimitUpgradeWithoutApplication.LimitUpgradeWithoutApplicationResourceResponse": { "required": [ "accountNo", "creditLimit" ], "type": "object", "properties": { "@id": { "type": "string", "nullable": true }, "accountNo": { "minLength": 1, "type": "string", "description": "The identifier of the account" }, "creditLimit": { "maximum": 100000000, "minimum": 0, "pattern": "^\\d+.?(\\d{1,2})?$", "type": "number", "description": "Credit limit on account applied for, can't have more than 2 decimal places", "format": "double" } }, "additionalProperties": false }, "V2.NationalConsumerIdentifier": { "required": [ "countryCode", "value" ], "type": "object", "properties": { "value": { "minLength": 1, "type": "string" }, "countryCode": { "minLength": 1, "pattern": "SE|NO|DK|FI", "type": "string" } }, "additionalProperties": false }, "V2.Offers.Applications.ApplicationsResourceBase": { "required": [ "creditLimit", "languageCode", "nationalConsumerIdentifier" ], "type": "object", "properties": { "@id": { "type": "string", "nullable": true }, "creditLimit": { "maximum": 100000000, "minimum": 0, "pattern": "^\\d+.?(\\d{1,2})?$", "type": "number", "description": "Credit limit on account applied for, can't have more than 2 decimal places", "format": "double" }, "nationalConsumerIdentifier": { "$ref": "#/components/schemas/V2.NationalConsumerIdentifier" }, "customerNo": { "type": "string", "description": "The identifier of the customer", "nullable": true }, "emailAddress": { "maxLength": 254, "minLength": 5, "pattern": "^[^;\\xA0\\xD0\\─@<>\\p{Cc}]+@(?!\\.)(?!.*\\.\\.)(?:[^;\\xA0\\xD0\\─@<>\\p{Cc}]+\\.[^;\\xA0\\xD0\\─@<>\\p{Cc}]+|\\[[A-Fa-f\\d\\:]+\\])(?\\p{Cc}]+@(?!\\.)(?!.*\\.\\.)(?:[^;\\xA0\\xD0\\─@<>\\p{Cc}]+\\.[^;\\xA0\\xD0\\─@<>\\p{Cc}]+|\\[[A-Fa-f\\d\\:]+\\])(?\\p{Cc}]+@(?!\\.)(?!.*\\.\\.)(?:[^;\\xA0\\xD0\\─@<>\\p{Cc}]+\\.[^;\\xA0\\xD0\\─@<>\\p{Cc}]+|\\[[A-Fa-f\\d\\:]+\\])(?