{"items":[{"type":"link","label":"Fondo Partner API","link":"/openapi/api","routeSlug":"/openapi/api","content":{"contentType":"overview","meta":{"name":"Fondo Partner API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api.json","url":"/_bundle/openapi/api.json?download"},{"kind":"download","label":"api.yaml","url":"/_bundle/openapi/api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"tech@fondo.se","label":"tech@fondo.se","withCopyButton":true,"copyContent":"tech@fondo.se"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://fondo.se/legal"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Fondo Partner API (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/openapi/api"}],"sectionId":"/openapi/api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is intended for registered partners in agreement with Fondo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API is subject to change."},"children":[]}]}]}]}],"sectionId":"/openapi/api/section/overview"}]}]}},{"type":"link","label":"Overview","link":"/openapi/api/section/overview","routeSlug":"/openapi/api/section/overview","content":null},{"type":"group","label":"Authorization","link":"/openapi/api/authorization","routeSlug":"/openapi/api/authorization","items":[{"label":"Obtain access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/authorization/authtoken","routeSlug":"/openapi/api/authorization/authtoken","metadata":{"seo":{"title":"Obtain access token","description":"Issues a short-lived bearer token using OAuth 2.0 Client Credentials. Send grant_type=client_credentials with your client_id and client_secret (optionally scope, state). Use the returned access_token in the Authorization: Bearer header on subsequent requests. The response also includes expires_in (seconds) and echoes state when provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authToken","name":"Obtain access token","isWebhook":false,"pointer":"/paths/~1v2~1partner~1auth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtain access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issues a short-lived bearer token using OAuth 2.0 Client Credentials. Send grant_type=client_credentials with your client_id and client_secret (optionally scope, state). Use the returned access_token in the Authorization: Bearer header on subsequent requests. The response also includes expires_in (seconds) and echoes state when provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credentials identify your partner account. The resulting token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/token_request"}},"schemaId":"components/schemas/token_request","pointer":"/paths/~1v2~1partner~1auth~1token/post/requestBody","description":"An AUTH token request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/partner/auth/token","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/token_request"}},"responseCodes":["200","400","500","503"],"pointer":"/v2/partner/auth/token","href":"authorization/authtoken","openApiOperationId":"authToken","summary":"Obtain access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"schemaId":"components/schemas/token_request","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/token_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Auth token response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/token_response"}},"schemaId":"components/schemas/token_response"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1auth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/token_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/token_response"}}},{"code":"400","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorization/authtoken"}],"panels":[]}]},"httpPath":"/v2/partner/auth/token"}],"content":{"contentType":"group","meta":{"name":"Authorization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorization","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain and manage access tokens via "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Client Credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokens are short-lived—reuse during validity and renew on expiry."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/auth/token","summary":"Obtain access token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorization/authtoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Accounts","link":"/openapi/api/account","routeSlug":"/openapi/api/account","items":[{"label":"List client's accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/getaccounts","routeSlug":"/openapi/api/account/getaccounts","metadata":{"seo":{"title":"List client's accounts","description":"Returns every investment account linked to clientId, including identifiers, type, status, balances, positions, linked bank accounts, currency, and timestamps. Use this to display or manage the client's full account set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccounts","name":"List client's accounts","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List client's accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns every investment account linked to clientId, including identifiers, type, status, balances, positions, linked bank accounts, currency, and timestamps. Use this to display or manage the client's full account set.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortedId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for pagination."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_44","description":"Limit results. Default is none\n"},{"name":"modifiedFrom","in":"query","schemaId":"schema_45","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modifiedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for reconciliation."},"children":[]}]}]}]},{"name":"ssn","in":"query","schemaId":"schema_46","description":"The social security number of account owner\n"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/account","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"start","in":"query","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","schemaId":"schema_43"},{"name":"limit","in":"query","example":100,"schemaId":"schema_44"},{"name":"modifiedFrom","in":"query","example":"2024-01-01T00:00:01.000Z","schemaId":"schema_45"},{"name":"ssn","in":"query","schemaId":"schema_46"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/account","href":"account/getaccounts","openApiOperationId":"getAccounts","summary":"List client's accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of accounts","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getaccounts"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account"},{"label":"Get owner performance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/getownerperformance","routeSlug":"/openapi/api/account/getownerperformance","metadata":{"seo":{"title":"Get owner performance","description":"Returns daily Time-Weighted Return (TWR) data aggregated across all accounts belonging to the owner identified by ssn or crn. Exactly one of ssn or crn must be provided. Each entry contains a date and the day's return as a decimal. An owner that has no accounts with this client yields an empty array."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOwnerPerformance","name":"Get owner performance","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1performance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get owner performance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns daily Time-Weighted Return (TWR) data aggregated across all accounts belonging to the owner identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided. Each entry contains a date and the day's return as a decimal. An owner that has no accounts with this client yields an empty array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default returns the full performance history. Optionally pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters (ISO 8601 dates) to limit the date range — both must be provided together."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1performance/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ssn","in":"query","schemaId":"schema_52","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Social security number of the owner. Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not both."},"children":[]}]}]}]},{"name":"crn","in":"query","schemaId":"schema_53","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company registration number of the owner. Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not both."},"children":[]}]}]}]},{"name":"start","in":"query","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date (inclusive) for the performance range. Must be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"end","in":"query","schemaId":"schema_55","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date (inclusive) for the performance range. Must be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1performance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/performance","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"ssn","in":"query","required":false,"example":"197001010003","schemaId":"components/schemas/ssn"},{"name":"crn","in":"query","required":false,"example":"5011121421","schemaId":"components/schemas/crn"},{"name":"start","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_54"},{"name":"end","in":"query","required":false,"example":"2025-03-01","schemaId":"schema_55"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/performance","href":"account/getownerperformance","openApiOperationId":"getOwnerPerformance","summary":"Get owner performance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account performance","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1performance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getownerperformance"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/performance"},{"label":"Get account performance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/getaccountperformance","routeSlug":"/openapi/api/account/getaccountperformance","metadata":{"seo":{"title":"Get account performance","description":"Returns daily Time-Weighted Return (TWR) data for the account. Each entry contains a date and the day's return as a decimal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountPerformance","name":"Get account performance","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1performance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account performance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns daily Time-Weighted Return (TWR) data for the account. Each entry contains a date and the day's return as a decimal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default returns the full performance history. Optionally pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters (ISO 8601 dates) to limit the date range — both must be provided together."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1performance/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date (inclusive) for the performance range. Must be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"end","in":"query","schemaId":"schema_55","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date (inclusive) for the performance range. Must be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1performance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/account/{accountId}/performance","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"start","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_54"},{"name":"end","in":"query","required":false,"example":"2025-03-01","schemaId":"schema_55"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/performance","href":"account/getaccountperformance","openApiOperationId":"getAccountPerformance","summary":"Get account performance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account performance","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1performance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getaccountperformance"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/performance"},{"label":"Get account market value","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/getaccountvalue","routeSlug":"/openapi/api/account/getaccountvalue","metadata":{"seo":{"title":"Get account market value","description":"Returns the total market value of the account, calculated as the sum of the settled cash balance, the value of settled fund positions, and pending subscription amounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountValue","name":"Get account market value","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1value/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account market value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the total market value of the account, calculated as the sum of the settled cash balance, the value of settled fund positions, and pending subscription amounts.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1value/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/account/{accountId}/value","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/value","href":"account/getaccountvalue","openApiOperationId":"getAccountValue","summary":"Get account market value"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account Value","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountValue"}},"schemaId":"components/schemas/accountValue"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1value/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/accountValue","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountValue"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getaccountvalue"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/value"},{"label":"Get kyc status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/getkycstatusbyaccount","routeSlug":"/openapi/api/account/getkycstatusbyaccount","metadata":{"seo":{"title":"Get kyc status","description":"Get status of kyc"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKycStatusByAccount","name":"Get kyc status","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1kycstatus~1account~1{accountId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get kyc status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get status of kyc"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true},{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1kycstatus~1account~1{accountId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/kycstatus/account/{accountId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"},{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/kycstatus/account/{accountId}","href":"account/getkycstatusbyaccount","openApiOperationId":"getKycStatusByAccount","summary":"Get kyc status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Status of kyc","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}},"schemaId":"schema_58"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1kycstatus~1account~1{accountId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_58","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getkycstatusbyaccount"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/kycstatus/account/{accountId}"},{"label":"Get account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/getaccountbyid","routeSlug":"/openapi/api/account/getaccountbyid","metadata":{"seo":{"title":"Get account","description":"Returns the full record for accountId under clientId, including identifiers, status, account and service type, owner details, balances and cumulative amounts, current positions, linked bank accounts, currency, and timestamps. Use this to display or verify a single investment account and its latest state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountById","name":"Get account","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the full record for accountId under clientId, including identifiers, status, account and service type, owner details, balances and cumulative amounts, current positions, linked bank accounts, currency, and timestamps. Use this to display or verify a single investment account and its latest state.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true},{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Executor-Ref","in":"header","schemaId":"schema_52","description":"Optional. SSN of the person making the request.\n"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/account/{accountId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"},{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"X-Executor-Ref","in":"header","required":false,"example":"197001010003","schemaId":"components/schemas/ssn"}],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}","href":"account/getaccountbyid","openApiOperationId":"getAccountById","summary":"Get account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account"}},"schemaId":"components/schemas/account"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/account","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getaccountbyid"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}"},{"label":"Close client account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/deleteaccount","routeSlug":"/openapi/api/account/deleteaccount","metadata":{"seo":{"title":"Close client account","description":"Marks the account accountId (under clientId) as closed so no new activity can occur. The response echoes the account record including deleted/closed state. Historical data remains available for regulatory/reporting needs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAccount","name":"Close client account","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close client account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Marks the account accountId (under clientId) as closed so no new activity can occur. The response echoes the account record including deleted/closed state. Historical data remains available for regulatory/reporting needs.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true},{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/partner/client/{clientId}/account/{accountId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"},{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}","href":"account/deleteaccount","openApiOperationId":"deleteAccount","summary":"Close client account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account"}},"schemaId":"components/schemas/account"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/account","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/deleteaccount"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}"},{"label":"List transfers for account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/getaccounttransfers","routeSlug":"/openapi/api/account/getaccounttransfers","metadata":{"seo":{"title":"List transfers for account","description":"Returns all 3rd-party transfer instructions associated with accountId under clientId. Each item includes the custodian, an external reference, the transfer status, and creation/modification timestamps."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountTransfers","name":"List transfers for account","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transfer/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List transfers for account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all 3rd-party transfer instructions associated with accountId under clientId.\nEach item includes the custodian, an external reference, the transfer status, and creation/modification timestamps.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transfer/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/account/{accountId}/transfer","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/transfer","href":"account/getaccounttransfers","openApiOperationId":"getAccountTransfers","summary":"List transfers for account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of transfers","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59"}},"schemaId":"schema_59"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transfer/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_59","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getaccounttransfers"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/transfer"},{"label":"List cash transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/getaccountcashtransactions","routeSlug":"/openapi/api/account/getaccountcashtransactions","metadata":{"seo":{"title":"List cash transactions","description":"Returns the cash ledger for accountId (under clientId), including transaction type (e.g., deposit/withdrawal/settlement/fee), references, accounts debited/credited, amount/currency, dates (createdDate, modifiedDate, settlementDate), and optional client/executor references. Use for cash reconciliation and statements."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountCashTransactions","name":"List cash transactions","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transaction~1cash/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cash transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the cash ledger for accountId (under clientId), including transaction type (e.g., deposit/withdrawal/settlement/fee), references, accounts debited/credited, amount/currency, dates (createdDate, modifiedDate, settlementDate), and optional client/executor references. Use for cash reconciliation and statements.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transaction~1cash/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortedId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for pagination."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_44","description":"Limit results. Default is none\n"},{"name":"modifiedFrom","in":"query","schemaId":"schema_45","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modifiedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for reconciliation."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transaction~1cash/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/account/{accountId}/transaction/cash","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"start","in":"query","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","schemaId":"schema_43"},{"name":"limit","in":"query","example":100,"schemaId":"schema_44"},{"name":"modifiedFrom","in":"query","example":"2024-01-01T00:00:01.000Z","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/transaction/cash","href":"account/getaccountcashtransactions","openApiOperationId":"getAccountCashTransactions","summary":"List cash transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of cash transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}},"schemaId":"schema_60"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transaction~1cash/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_60","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getaccountcashtransactions"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/transaction/cash"},{"label":"List fund transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/getaccountfundtransactions","routeSlug":"/openapi/api/account/getaccountfundtransactions","metadata":{"seo":{"title":"List fund transactions","description":"Returns fund activity for accountId (under clientId) such as subscriptions/redemptions with instrument identifiers, units, price, currency, references, and key dates (tradeDate, settlementDate). Use to build position histories and confirm settled/unspecified units."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountFundTransactions","name":"List fund transactions","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transaction~1fund/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List fund transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns fund activity for accountId (under clientId) such as subscriptions/redemptions with instrument identifiers, units, price, currency, references, and key dates (tradeDate, settlementDate). Use to build position histories and confirm settled/unspecified units.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transaction~1fund/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortedId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for pagination."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_44","description":"Limit results. Default is none\n"},{"name":"modifiedFrom","in":"query","schemaId":"schema_45","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modifiedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for reconciliation."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transaction~1fund/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/account/{accountId}/transaction/fund","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"start","in":"query","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","schemaId":"schema_43"},{"name":"limit","in":"query","example":100,"schemaId":"schema_44"},{"name":"modifiedFrom","in":"query","example":"2024-01-01T00:00:01.000Z","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/transaction/fund","href":"account/getaccountfundtransactions","openApiOperationId":"getAccountFundTransactions","summary":"List fund transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of fund transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1transaction~1fund/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getaccountfundtransactions"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/transaction/fund"},{"label":"Create withdrawal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/createwithdrawal","routeSlug":"/openapi/api/account/createwithdrawal","metadata":{"seo":{"title":"Create withdrawal","description":"Initiates a payout from accountId (under clientId). Provide withdrawal details (e.g., withdrawalType, target bankAccount) in the request body. The response returns the created transaction with identifiers, amounts, and settlement metadata for tracking."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWithdrawal","name":"Create withdrawal","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1withdrawal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create withdrawal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiates a payout from accountId (under clientId). Provide withdrawal details (e.g., withdrawalType, target bankAccount) in the request body. The response returns the created transaction with identifiers, amounts, and settlement metadata for tracking.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1withdrawal/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/withdrawal_request"}},"schemaId":"components/schemas/withdrawal_request","pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1withdrawal/post/requestBody","description":"Withdrawal request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/partner/client/{clientId}/account/{accountId}/withdrawal","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/withdrawal_request"}},"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/withdrawal","href":"account/createwithdrawal","openApiOperationId":"createWithdrawal","summary":"Create withdrawal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"schemaId":"components/schemas/withdrawal_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/withdrawal_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cash transaction","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cashTransaction"}},"schemaId":"components/schemas/cashTransaction"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1withdrawal/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/cashTransaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cashTransaction"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/createwithdrawal"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/withdrawal"},{"label":"Get Swish deposit status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/pollswishdeposit","routeSlug":"/openapi/api/account/pollswishdeposit","metadata":{"seo":{"title":"Get Swish deposit status","description":"Returns the current status of a previously initiated Swish deposit session. Use to confirm whether the deposit is pending or successfully paid; errorCode provides additional context if applicable."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pollSwishDeposit","name":"Get Swish deposit status","isWebhook":false,"pointer":"/paths/~1v2~1partner~1deposit~1swish~1{swishId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Swish deposit status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the current status of a previously initiated Swish deposit session. Use to confirm whether the deposit is pending or successfully paid; errorCode provides additional context if applicable.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"swishId","in":"path","schemaId":"schema_42","description":"The swish ID returned from swish deposit session\n","required":true}],"pointer":"/paths/~1v2~1partner~1deposit~1swish~1{swishId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/deposit/swish/{swishId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"swishId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/deposit/swish/{swishId}","href":"account/pollswishdeposit","openApiOperationId":"pollSwishDeposit","summary":"Get Swish deposit status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Swish deposit session status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/swish_poll_response"}},"schemaId":"components/schemas/swish_poll_response"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1deposit~1swish~1{swishId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/swish_poll_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/swish_poll_response"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/pollswishdeposit"}],"panels":[]}]},"httpPath":"/v2/partner/deposit/swish/{swishId}"},{"label":"Create Swish deposit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/createswishdeposit","routeSlug":"/openapi/api/account/createswishdeposit","metadata":{"seo":{"title":"Create Swish deposit","description":"Starts a new Swish payment session for accountId (under clientId). Send details like type (e.g., same_device), amount, and optional qrFormat. The response includes a session id, token, optional qrImage, and a paymentId to track the flow through status checks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSwishDeposit","name":"Create Swish deposit","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1deposit~1swish/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Swish deposit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts a new Swish payment session for accountId (under clientId). Send details like type (e.g., same_device), amount, and optional qrFormat. The response includes a session id, token, optional qrImage, and a paymentId to track the flow through status checks."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1deposit~1swish/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/deposit_swish"}},"schemaId":"components/schemas/deposit_swish","pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1deposit~1swish/post/requestBody","description":"Swish deposit"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/partner/client/{clientId}/account/{accountId}/deposit/swish","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/deposit_swish"}},"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/deposit/swish","href":"account/createswishdeposit","openApiOperationId":"createSwishDeposit","summary":"Create Swish deposit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"schemaId":"components/schemas/deposit_swish","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/deposit_swish"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Swish deposit session information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/swish_deposit_response"}},"schemaId":"components/schemas/swish_deposit_response"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1deposit~1swish/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/swish_deposit_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/swish_deposit_response"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/createswishdeposit"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/deposit/swish"},{"label":"Get withdrawal limit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/account/getwithdrawallimit","routeSlug":"/openapi/api/account/getwithdrawallimit","metadata":{"seo":{"title":"Get withdrawal limit","description":"Returns the minimum and maximum withdrawable amounts for the given account. For insurance accounts, the limits are determined by the insurance provider. For other account types, the minimum is 0 and the maximum equals the current cash balance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWithdrawalLimit","name":"Get withdrawal limit","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{client_id}~1account~1{account_id}~1withdrawal~1limit/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get withdrawal limit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the minimum and maximum withdrawable amounts for the given account. For insurance accounts, the limits are determined by the insurance provider. For other account types, the minimum is 0 and the maximum equals the current cash balance.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_62","description":"The ID of requested client.\n"},{"name":"account_id","in":"path","schemaId":"schema_62","description":"The ID of requested account.\n"}],"pointer":"/paths/~1v2~1partner~1client~1{client_id}~1account~1{account_id}~1withdrawal~1limit/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{client_id}/account/{account_id}/withdrawal/limit","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"client_id","in":"path","schemaId":"schema_62"},{"name":"account_id","in":"path","schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{client_id}/account/{account_id}/withdrawal/limit","href":"account/getwithdrawallimit","openApiOperationId":"getWithdrawalLimit","summary":"Get withdrawal limit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Withdrawal limit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/withdrawal_limit"}},"schemaId":"components/schemas/withdrawal_limit"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{client_id}~1account~1{account_id}~1withdrawal~1limit/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/withdrawal_limit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/withdrawal_limit"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/getwithdrawallimit"}],"panels":[]}]},"httpPath":"/v2/partner/client/{client_id}/account/{account_id}/withdrawal/limit"}],"content":{"contentType":"group","meta":{"name":"Account"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hold investor positions, balances, and cash movements under a client."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints let you "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fetch details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"close accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responses include status, owner info, currency, linked bank accounts, positions, and timestamps."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client/{clientId}/account","summary":"List client's accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getaccounts","deprecated":false},{"title":"/v2/partner/client/{clientId}/performance","summary":"Get owner performance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getownerperformance","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}/performance","summary":"Get account performance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getaccountperformance","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}/value","summary":"Get account market value","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getaccountvalue","deprecated":false},{"title":"/v2/partner/client/{clientId}/kycstatus/account/{accountId}","summary":"Get kyc status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getkycstatusbyaccount","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}","summary":"Get account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getaccountbyid","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}","summary":"Close client account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account/deleteaccount","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}/transfer","summary":"List transfers for account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getaccounttransfers","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}/transaction/cash","summary":"List cash transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getaccountcashtransactions","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}/transaction/fund","summary":"List fund transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getaccountfundtransactions","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}/withdrawal","summary":"Create withdrawal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account/createwithdrawal","deprecated":false},{"title":"/v2/partner/deposit/swish/{swishId}","summary":"Get Swish deposit status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/pollswishdeposit","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}/deposit/swish","summary":"Create Swish deposit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account/createswishdeposit","deprecated":false},{"title":"/v2/partner/client/{client_id}/account/{account_id}/withdrawal/limit","summary":"Get withdrawal limit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/getwithdrawallimit","deprecated":false}]}]}]}]}},{"type":"group","label":"Agreements","link":"/openapi/api/agreement","routeSlug":"/openapi/api/agreement","items":[{"label":"Get agreement types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/agreement/getaccountagreementtypes","routeSlug":"/openapi/api/agreement/getaccountagreementtypes","metadata":{"seo":{"title":"Get agreement types","description":"Get available agreement types for an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountAgreementTypes","name":"Get agreement types","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1agreement-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get agreement types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get available agreement types for an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1agreement-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/account/{accountId}/agreement-types","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/agreement-types","href":"agreement/getaccountagreementtypes","openApiOperationId":"getAccountAgreementTypes","summary":"Get agreement types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Agreement types","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_63"}},"schemaId":"schema_63"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1agreement-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_63","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_63"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agreement/getaccountagreementtypes"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/agreement-types"},{"label":"Get agreement PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/agreement/getaccountagreementpdf","routeSlug":"/openapi/api/agreement/getaccountagreementpdf","metadata":{"seo":{"title":"Get agreement PDF","description":"Get agreement document in PDF format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountAgreementPdf","name":"Get agreement PDF","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1agreement~1{agreementTypeKey}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get agreement PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get agreement document in PDF format."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true},{"name":"agreementTypeKey","in":"path","schemaId":"schema_62","description":"The key of the requested agreement type.\n","required":true,"example":"account"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1agreement~1{agreementTypeKey}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/account/{accountId}/agreement/{agreementTypeKey}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"},{"name":"agreementTypeKey","in":"path","required":true,"example":"account","schemaId":"schema_62"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/agreement/{agreementTypeKey}","href":"agreement/getaccountagreementpdf","openApiOperationId":"getAccountAgreementPdf","summary":"Get agreement PDF"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Agreement document in PDF format","mediaType":"application/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_64"}},"schemaId":"schema_64"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1agreement~1{agreementTypeKey}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_64","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_64"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agreement/getaccountagreementpdf"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/agreement/{agreementTypeKey}"}],"content":{"contentType":"group","meta":{"name":"Agreement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Agreements","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve account agreements and generate PDF documents for account-related contracts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client/{clientId}/account/{accountId}/agreement-types","summary":"Get agreement types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agreement/getaccountagreementtypes","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}/agreement/{agreementTypeKey}","summary":"Get agreement PDF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agreement/getaccountagreementpdf","deprecated":false}]}]}]}]}},{"type":"group","label":"Clients","link":"/openapi/api/client","routeSlug":"/openapi/api/client","items":[{"label":"List clients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/client/getclients","routeSlug":"/openapi/api/client/getclients","metadata":{"seo":{"title":"List clients","description":"Returns all clients associated with the authenticated partner, including IDs, display names, bank account info for fees/settlements, service types, registration/country details, and timestamps. Use to show or manage your client portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClients","name":"List clients","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List clients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all clients associated with the authenticated partner, including IDs, display names, bank account info for fees/settlements, service types, registration/country details, and timestamps. Use to show or manage your client portfolio.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortedId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for pagination."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_44","description":"Limit results. Default is none\n"},{"name":"modifiedFrom","in":"query","schemaId":"schema_45","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modifiedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for reconciliation."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1partner~1client/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[],"query":[{"name":"start","in":"query","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","schemaId":"schema_43"},{"name":"limit","in":"query","example":100,"schemaId":"schema_44"},{"name":"modifiedFrom","in":"query","example":"2024-01-01T00:00:01.000Z","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client","href":"client/getclients","openApiOperationId":"getClients","summary":"List clients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of clients","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}},"schemaId":"schema_65"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_65","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/client/getclients"}],"panels":[]}]},"httpPath":"/v2/partner/client"},{"label":"Create client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/client/createclient","routeSlug":"/openapi/api/client/createclient","metadata":{"seo":{"title":"Create client","description":"Creates a client record (company or individual) with identifiers (name, displayName, optional id), regulatory and operational details (crn, country), optional bank accounts for fee handling, and service types. The response returns the full persisted client including sortedId and timestamps."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createClient","name":"Create client","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a client record (company or individual) with identifiers (name, displayName, optional id), regulatory and operational details (crn, country), optional bank accounts for fee handling, and service types. The response returns the full persisted client including sortedId and timestamps.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/client"}},"schemaId":"components/schemas/client","pointer":"/paths/~1v2~1partner~1client/post/requestBody","description":"Create client request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/partner/client","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/client"}},"responseCodes":["204","400","401","403","500","503"],"pointer":"/v2/partner/client","href":"client/createclient","openApiOperationId":"createClient","summary":"Create client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"schemaId":"components/schemas/client","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/client"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"client","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/client"}},"schemaId":"components/schemas/client"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"components/schemas/client","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/client"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/client/createclient"}],"panels":[]}]},"httpPath":"/v2/partner/client"},{"label":"Get client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/client/getclientbyid","routeSlug":"/openapi/api/client/getclientbyid","metadata":{"seo":{"title":"Get client","description":"Returns the full client object for clientId, including names, service types (with any assigned codes), bank accounts, and timestamps. Use to display or verify a single client's profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClientById","name":"Get client","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the full client object for clientId, including names, service types (with any assigned codes), bank accounts, and timestamps. Use to display or verify a single client's profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}","href":"client/getclientbyid","openApiOperationId":"getClientById","summary":"Get client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"client","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/client"}},"schemaId":"components/schemas/client"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/client","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/client"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/client/getclientbyid"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}"},{"label":"Update client","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/client/updateclient","routeSlug":"/openapi/api/client/updateclient","metadata":{"seo":{"title":"Update client","description":"Partially updates the client identified by clientId. Provide only the fields to change (e.g., displayName, bank accounts, service types, country). The response returns the updated client with refreshed timestamps."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateClient","name":"Update client","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates the client identified by clientId. Provide only the fields to change (e.g., displayName, bank accounts, service types, country). The response returns the updated client with refreshed timestamps.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patchClient"}},"schemaId":"components/schemas/patchClient","pointer":"/paths/~1v2~1partner~1client~1{clientId}/patch/requestBody","description":"Modify client request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/partner/client/{clientId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patchClient"}},"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}","href":"client/updateclient","openApiOperationId":"updateClient","summary":"Update client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"schemaId":"components/schemas/patchClient","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patchClient"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"client","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/client"}},"schemaId":"components/schemas/client"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/client","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/client"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/client/updateclient"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}"},{"label":"List client's instrument universe","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/client/getclientinstrumentuniverse","routeSlug":"/openapi/api/client/getclientinstrumentuniverse","metadata":{"seo":{"title":"List client's instrument universe","description":"Returns instruments available for the given clientId, including identifiers (id, isincode), name, currency, latest price (closePrice, priceDate), KIID links, trade flags (isBuyable, isSellable, isTradable), cost breakdowns, rebates, and rules (unit decimals, minimum investment). Use to power search, eligibility checks, and order tickets for that client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClientInstrumentUniverse","name":"List client's instrument universe","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instrument/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List client's instrument universe","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instruments available for the given clientId, including identifiers (id, isincode), name, currency, latest price (closePrice, priceDate), KIID links, trade flags (isBuyable, isSellable, isTradable), cost breakdowns, rebates, and rules (unit decimals, minimum investment). Use to power search, eligibility checks, and order tickets for that client.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instrument/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/instrument","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/instrument","href":"client/getclientinstrumentuniverse","openApiOperationId":"getClientInstrumentUniverse","summary":"List client's instrument universe"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of instruments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}},"schemaId":"schema_66"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instrument/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_66","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/client/getclientinstrumentuniverse"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/instrument"}],"content":{"contentType":"group","meta":{"name":"Client"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clients","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the legal entity that holds power of attorney over end-investor accounts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list, create, read, and update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" clients, manage bank"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accounts and service types, and fetch client-specific resources (instruments, custodians)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client","summary":"List clients","prefix":{"name":"get","color":"get"},"badges":[],"link":"/client/getclients","deprecated":false},{"title":"/v2/partner/client","summary":"Create client","prefix":{"name":"post","color":"post"},"badges":[],"link":"/client/createclient","deprecated":false},{"title":"/v2/partner/client/{clientId}","summary":"Get client","prefix":{"name":"get","color":"get"},"badges":[],"link":"/client/getclientbyid","deprecated":false},{"title":"/v2/partner/client/{clientId}","summary":"Update client","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/client/updateclient","deprecated":false},{"title":"/v2/partner/client/{clientId}/instrument","summary":"List client's instrument universe","prefix":{"name":"get","color":"get"},"badges":[],"link":"/client/getclientinstrumentuniverse","deprecated":false}]}]}]}]}},{"type":"group","label":"Custodians","link":"/openapi/api/custodian","routeSlug":"/openapi/api/custodian","items":[{"label":"List client custodians","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/custodian/getcustodians","routeSlug":"/openapi/api/custodian/getcustodians","metadata":{"seo":{"title":"List client custodians","description":"Returns all custodians (e.g., for transfers), including identifiers and display names. Use this to populate custodian selectors or to validate transfer instructions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustodians","name":"List client custodians","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1custodian/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List client custodians","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all custodians (e.g., for transfers), including identifiers and display names. Use this to populate custodian selectors or to validate transfer instructions.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1custodian/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/custodian","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/custodian","href":"custodian/getcustodians","openApiOperationId":"getCustodians","summary":"List client custodians"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of custodians","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_67"}},"schemaId":"schema_67"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1custodian/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_67","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_67"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custodian/getcustodians"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/custodian"}],"content":{"contentType":"group","meta":{"name":"Custodian"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custodians","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custodians"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" linked to a client—useful for transfer instructions and operational routing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns identifiers and names for display and validation."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client/{clientId}/custodian","summary":"List client custodians","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custodian/getcustodians","deprecated":false}]}]}]}]}},{"type":"group","label":"Journeys (Hosted Flows)","link":"/openapi/api/journey","routeSlug":"/openapi/api/journey","items":[{"label":"Get journey","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/journey/getjourney","routeSlug":"/openapi/api/journey/getjourney","metadata":{"seo":{"title":"Get journey","description":"Returns the current state, configuration, and outcome of a web journey identified by journeyId under clientId (e.g., createAccount). Includes journey URL, expiry, callback/redirect URLs, context/scope, and any produced results (such as created account, bank account, transfer instructions, allocation plan). Use it to monitor progress and fetch results after end-customer completion."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJourney","name":"Get journey","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey~1{journeyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the current state, configuration, and outcome of a web journey identified by journeyId under clientId (e.g., createAccount). Includes journey URL, expiry, callback/redirect URLs, context/scope, and any produced results (such as created account, bank account, transfer instructions, allocation plan). Use it to monitor progress and fetch results after end-customer completion.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"journeyId","in":"path","schemaId":"schema_42","description":"The ID of requested journey.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey~1{journeyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/journey/{journeyId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"journeyId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/journey/{journeyId}","href":"journey/getjourney","openApiOperationId":"getJourney","summary":"Get journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"journey","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/journey"}},"schemaId":"components/schemas/journey"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey~1{journeyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/journey","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/journey"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/callbackUrl}","summary":"Journey callback","callbackName":"onResourceEvent","callbackId":"onResourceEvent/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/journeyCallback"}},"schemaId":"components/schemas/journeyCallback","pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey~1{journeyId}/get/callbacks/onResourceEvent/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Callback successfully recieved."},{"code":"400","description":"Bad request"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey~1{journeyId}/get/callbacks/onResourceEvent/post/responses"}]},"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey~1{journeyId}/get/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"onResourceEvent/post","path":"{$request.body#/callbackUrl}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_68"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journey/getjourney"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/journey/{journeyId}"},{"label":"Create journey","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/journey/postjourney","routeSlug":"/openapi/api/journey/postjourney","metadata":{"seo":{"title":"Create journey","description":"Initiates a new web journey (e.g., createAccount) for the specified clientId. Provide journey configuration (account types, service type, optional allocation plan, KYC questions, transfer instructions) plus callback/redirect URLs. The response returns a journey id, a launchable url, status, and metadata you can track until completion."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postJourney","name":"Create journey","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create journey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiates a new web journey (e.g., createAccount) for the specified clientId. Provide journey configuration (account types, service type, optional allocation plan, KYC questions, transfer instructions) plus callback/redirect URLs. The response returns a journey id, a launchable url, status, and metadata you can track until completion.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/journey_post"}},"schemaId":"components/schemas/journey_post","pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey/post/requestBody","description":"Create journey request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/partner/client/{clientId}/journey","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/journey_post"}},"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/journey","href":"journey/postjourney","openApiOperationId":"postJourney","summary":"Create journey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"schemaId":"components/schemas/journey_post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/journey_post"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"journey","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/journey"}},"schemaId":"components/schemas/journey"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/journey","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/journey"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/callbackUrl}","summary":"Journey callback","callbackName":"onResourceEvent","callbackId":"onResourceEvent/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/journeyCallback"}},"schemaId":"components/schemas/journeyCallback","pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey/post/callbacks/onResourceEvent/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Callback successfully recieved."},{"code":"400","description":"Bad request"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey/post/callbacks/onResourceEvent/post/responses"}]},"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1journey/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"onResourceEvent/post","path":"{$request.body#/callbackUrl}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_68"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journey/postjourney"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/journey"}],"content":{"contentType":"group","meta":{"name":"Journey"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Journeys (Hosted Flows)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journeys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are secure, hosted web flows for customer interactions: account opening (e-sign),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC/KYB questionnaires, fund transfers, and allocation plan setup."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Journey via API, redirect customers to the time-limited URL, and poll/callback for results."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client/{clientId}/journey/{journeyId}","summary":"Get journey","prefix":{"name":"get","color":"get"},"badges":[],"link":"/journey/getjourney","deprecated":false},{"title":"/v2/partner/client/{clientId}/journey","summary":"Create journey","prefix":{"name":"post","color":"post"},"badges":[],"link":"/journey/postjourney","deprecated":false}]}]}]}]}},{"type":"group","label":"Allocation Plans","link":"/openapi/api/allocationplan","routeSlug":"/openapi/api/allocationplan","items":[{"label":"List allocation plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/allocationplan/getallocationplans","routeSlug":"/openapi/api/allocationplan/getallocationplans","metadata":{"seo":{"title":"List allocation plans","description":"Returns all allocation plans for the specified client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllocationPlans","name":"List allocation plans","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List allocation plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all allocation plans for the specified client.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/allocationplan","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/allocationplan","href":"allocationplan/getallocationplans","openApiOperationId":"getAllocationPlans","summary":"List allocation plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of allocation plans","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69"}},"schemaId":"schema_69"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_69","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allocationplan/getallocationplans"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/allocationplan"},{"label":"Get allocation plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/allocationplan/getallocationplan","routeSlug":"/openapi/api/allocationplan/getallocationplan","metadata":{"seo":{"title":"Get allocation plan","description":"Returns a single allocation plan by ID for the specified client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllocationPlan","name":"Get allocation plan","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan~1{allocationPlanId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get allocation plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single allocation plan by ID for the specified client.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"allocationPlanId","in":"path","schemaId":"schema_70","description":"The ID of the requested allocation plan.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan~1{allocationPlanId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/allocationplan/{allocationPlanId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"allocationPlanId","in":"path","required":true,"example":"49ad7378-121c-4a53-9894-dfd14a7b4877","schemaId":"components/schemas/uuid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/allocationplan/{allocationPlanId}","href":"allocationplan/getallocationplan","openApiOperationId":"getAllocationPlan","summary":"Get allocation plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Allocation plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/allocationPlan"}},"schemaId":"components/schemas/allocationPlan"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan~1{allocationPlanId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/allocationPlan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/allocationPlan"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allocationplan/getallocationplan"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/allocationplan/{allocationPlanId}"},{"label":"Delete allocation plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/allocationplan/deleteallocationplan","routeSlug":"/openapi/api/allocationplan/deleteallocationplan","metadata":{"seo":{"title":"Delete allocation plan","description":"Deletes an allocation plan by ID for the specified client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAllocationPlan","name":"Delete allocation plan","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan~1{allocationPlanId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete allocation plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an allocation plan by ID for the specified client.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"allocationPlanId","in":"path","schemaId":"schema_70","description":"The ID of the requested allocation plan.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan~1{allocationPlanId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/partner/client/{clientId}/allocationplan/{allocationPlanId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"allocationPlanId","in":"path","required":true,"example":"49ad7378-121c-4a53-9894-dfd14a7b4877","schemaId":"components/schemas/uuid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/allocationplan/{allocationPlanId}","href":"allocationplan/deleteallocationplan","openApiOperationId":"deleteAllocationPlan","summary":"Delete allocation plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Allocation plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/allocationPlan"}},"schemaId":"components/schemas/allocationPlan"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan~1{allocationPlanId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/allocationPlan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/allocationPlan"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allocationplan/deleteallocationplan"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/allocationplan/{allocationPlanId}"},{"label":"Get allocation plan by account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/allocationplan/getallocationplanbyaccount","routeSlug":"/openapi/api/allocationplan/getallocationplanbyaccount","metadata":{"seo":{"title":"Get allocation plan by account","description":"Returns the allocation plan associated with the specified account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllocationPlanByAccount","name":"Get allocation plan by account","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan~1account~1{accountId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get allocation plan by account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the allocation plan associated with the specified account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan~1account~1{accountId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/allocationplan/account/{accountId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/allocationplan/account/{accountId}","href":"allocationplan/getallocationplanbyaccount","openApiOperationId":"getAllocationPlanByAccount","summary":"Get allocation plan by account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Allocation plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/allocationPlan"}},"schemaId":"components/schemas/allocationPlan"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1allocationplan~1account~1{accountId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/allocationPlan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/allocationPlan"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allocationplan/getallocationplanbyaccount"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/allocationplan/account/{accountId}"}],"content":{"contentType":"group","meta":{"name":"AllocationPlan"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allocation Plans","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allocation plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allow deposits to be distributed across instruments for an account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List, fetch, and delete allocation plans. Allocation plans are created and updated via journeys."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client/{clientId}/allocationplan","summary":"List allocation plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/allocationplan/getallocationplans","deprecated":false},{"title":"/v2/partner/client/{clientId}/allocationplan/{allocationPlanId}","summary":"Get allocation plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/allocationplan/getallocationplan","deprecated":false},{"title":"/v2/partner/client/{clientId}/allocationplan/{allocationPlanId}","summary":"Delete allocation plan","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/allocationplan/deleteallocationplan","deprecated":false},{"title":"/v2/partner/client/{clientId}/allocationplan/account/{accountId}","summary":"Get allocation plan by account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/allocationplan/getallocationplanbyaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Savings Plans","link":"/openapi/api/savingsplan","routeSlug":"/openapi/api/savingsplan","items":[{"label":"Get savings plan by account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/savingsplan/getsavingsplanbyaccount","routeSlug":"/openapi/api/savingsplan/getsavingsplanbyaccount","metadata":{"seo":{"title":"Get savings plan by account","description":"Returns the savings plan associated with the specified account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSavingsPlanByAccount","name":"Get savings plan by account","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1savingsplan/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get savings plan by account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the savings plan associated with the specified account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1savingsplan/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/account/{accountId}/savingsplan","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/savingsplan","href":"savingsplan/getsavingsplanbyaccount","openApiOperationId":"getSavingsPlanByAccount","summary":"Get savings plan by account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Savings plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/savingsPlan"}},"schemaId":"components/schemas/savingsPlan"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1savingsplan/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/savingsPlan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/savingsPlan"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savingsplan/getsavingsplanbyaccount"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/savingsplan"},{"label":"Delete savings plan by account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/savingsplan/deletesavingsplanbyaccount","routeSlug":"/openapi/api/savingsplan/deletesavingsplanbyaccount","metadata":{"seo":{"title":"Delete savings plan by account","description":"Deletes the savings plan associated with the specified account. Returns the deleted savings plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSavingsPlanByAccount","name":"Delete savings plan by account","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1savingsplan/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete savings plan by account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the savings plan associated with the specified account.\nReturns the deleted savings plan.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"accountId","in":"path","schemaId":"schema_42","description":"The ID of requested account.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1savingsplan/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/partner/client/{clientId}/account/{accountId}/savingsplan","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"accountId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/account/{accountId}/savingsplan","href":"savingsplan/deletesavingsplanbyaccount","openApiOperationId":"deleteSavingsPlanByAccount","summary":"Delete savings plan by account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Savings plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/savingsPlan"}},"schemaId":"components/schemas/savingsPlan"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1account~1{accountId}~1savingsplan/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/savingsPlan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/savingsPlan"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/savingsplan/deletesavingsplanbyaccount"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/account/{accountId}/savingsplan"}],"content":{"contentType":"group","meta":{"name":"SavingsPlan"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Savings Plans","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Savings plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" define recurring fixed-amount investments into instruments for an account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Savings plans are created via journeys and can be fetched by account."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client/{clientId}/account/{accountId}/savingsplan","summary":"Get savings plan by account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/savingsplan/getsavingsplanbyaccount","deprecated":false},{"title":"/v2/partner/client/{clientId}/account/{accountId}/savingsplan","summary":"Delete savings plan by account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/savingsplan/deletesavingsplanbyaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Instruments","link":"/openapi/api/instrument","routeSlug":"/openapi/api/instrument","items":[{"label":"List instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/instrument/getinstruments","routeSlug":"/openapi/api/instrument/getinstruments","metadata":{"seo":{"title":"List instruments","description":"Returns all mutual fund instruments available on the platform, including identifiers, currency, latest prices and dates, KIID links, tradability flags, costs/fees, rebates, and instrument rules (unit decimals, minimums). Use for global discovery, search, or to pre-filter a client's instrument set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstruments","name":"List instruments","isWebhook":false,"pointer":"/paths/~1v2~1partner~1instrument/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List instruments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all mutual fund instruments available on the platform, including identifiers, currency, latest prices and dates, KIID links, tradability flags, costs/fees, rebates, and instrument rules (unit decimals, minimums). Use for global discovery, search, or to pre-filter a client's instrument set.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/instrument","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/instrument","href":"instrument/getinstruments","openApiOperationId":"getInstruments","summary":"List instruments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of instruments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}},"schemaId":"schema_66"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1instrument/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_66","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instrument/getinstruments"}],"panels":[]}]},"httpPath":"/v2/partner/instrument"},{"label":"Get instrument","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/instrument/getinstrumentbyid","routeSlug":"/openapi/api/instrument/getinstrumentbyid","metadata":{"seo":{"title":"Get instrument","description":"Returns the full instrument record for instrumentId, including identifiers (id, isincode), name, currency, latest pricing, KIID links, tradability flags, cost breakdowns, rebates, and unit/amount constraints. Use to power instrument detail pages and to validate order tickets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstrumentById","name":"Get instrument","isWebhook":false,"pointer":"/paths/~1v2~1partner~1instrument~1{instrumentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the full instrument record for instrumentId, including identifiers (id, isincode), name, currency, latest pricing, KIID links, tradability flags, cost breakdowns, rebates, and unit/amount constraints. Use to power instrument detail pages and to validate order tickets.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"instrumentId","in":"path","schemaId":"schema_42","description":"The ID of requested instrument.\n","required":true}],"pointer":"/paths/~1v2~1partner~1instrument~1{instrumentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/instrument/{instrumentId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"instrumentId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/instrument/{instrumentId}","href":"instrument/getinstrumentbyid","openApiOperationId":"getInstrumentById","summary":"Get instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Instrument","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/instrument"}},"schemaId":"components/schemas/instrument"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1instrument~1{instrumentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/instrument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/instrument"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instrument/getinstrumentbyid"}],"panels":[]}]},"httpPath":"/v2/partner/instrument/{instrumentId}"},{"label":"Get instrument prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/instrument/getinstrumentprices","routeSlug":"/openapi/api/instrument/getinstrumentprices","metadata":{"seo":{"title":"Get instrument prices","description":"Returns historical price data for the instrument identified by instrumentId. Filter by date range using start and end query parameters (YYYY-MM-DD). The date range is limited to a maximum of 365 days. Only available for specific clients in agreement with Morningstar."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstrumentPrices","name":"Get instrument prices","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instrument~1{instrumentId}~1prices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instrument prices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns historical price data for the instrument identified by instrumentId.\nFilter by date range using start and end query parameters (YYYY-MM-DD).\nThe date range is limited to a maximum of 365 days.\nOnly available for specific clients in agreement with Morningstar.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"instrumentId","in":"path","schemaId":"schema_42","description":"The ID of requested instrument.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instrument~1{instrumentId}~1prices/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_54","description":"Start date for the price range (YYYY-MM-DD).\n"},{"name":"end","in":"query","schemaId":"schema_71","description":"End date for the price range (YYYY-MM-DD).\n"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instrument~1{instrumentId}~1prices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/instrument/{instrumentId}/prices","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"instrumentId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"start","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_54"},{"name":"end","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_71"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503"],"pointer":"/v2/partner/client/{clientId}/instrument/{instrumentId}/prices","href":"instrument/getinstrumentprices","openApiOperationId":"getInstrumentPrices","summary":"Get instrument prices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of instrument prices","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fundPrices"}},"schemaId":"components/schemas/fundPrices"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":"Resource not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72"}},"schemaId":"schema_72"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instrument~1{instrumentId}~1prices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/fundPrices","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fundPrices"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"429","schemaId":"schema_72","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instrument/getinstrumentprices"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/instrument/{instrumentId}/prices"}],"content":{"contentType":"group","meta":{"name":"Instrument"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Instruments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instrument universe"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" consists of mutual funds available for a given client or globally."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve instrument metadata: identifiers (e.g., ISIN), currency, latest price, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KIID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" links,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tradability flags, unit decimals, minimums, and cost/fee breakdowns."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/instrument","summary":"List instruments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instrument/getinstruments","deprecated":false},{"title":"/v2/partner/instrument/{instrumentId}","summary":"Get instrument","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instrument/getinstrumentbyid","deprecated":false},{"title":"/v2/partner/client/{clientId}/instrument/{instrumentId}/prices","summary":"Get instrument prices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instrument/getinstrumentprices","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Instructions","link":"/openapi/api/instruction","routeSlug":"/openapi/api/instruction","items":[{"label":"Create payment instruction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/instruction/createpaymentinstruction","routeSlug":"/openapi/api/instruction/createpaymentinstruction","metadata":{"seo":{"title":"Create payment instruction","description":"Creates a new payment instruction of the specified type (for example autogiro) for the client identified by clientId. Provide an array of payments with details such as amount, destination account, and a unique clientRef. The response returns the instruction id, the list of created payments, a bankTransferRef if available, and the initial status (for example new) so you can track subsequent processing and settlements."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentInstruction","name":"Create payment instruction","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instruction~1payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create payment instruction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new payment instruction of the specified type (for example autogiro) for the client identified by clientId.\nProvide an array of payments with details such as amount, destination account, and a unique clientRef.\nThe response returns the instruction id, the list of created payments, a bankTransferRef if available, and the initial status (for example new) so you can track subsequent processing and settlements.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instruction~1payment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/post_payment_instruction"}},"schemaId":"components/schemas/post_payment_instruction","pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instruction~1payment/post/requestBody","description":"Create instruction of payments"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/partner/client/{clientId}/instruction/payment","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/post_payment_instruction"}},"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/instruction/payment","href":"instruction/createpaymentinstruction","openApiOperationId":"createPaymentInstruction","summary":"Create payment instruction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"schemaId":"components/schemas/post_payment_instruction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/post_payment_instruction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Instruction of payments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paymentInstruction"}},"schemaId":"components/schemas/paymentInstruction"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instruction~1payment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/paymentInstruction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paymentInstruction"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instruction/createpaymentinstruction"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/instruction/payment"},{"label":"Get payments by instruction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/instruction/getinstructionpayment","routeSlug":"/openapi/api/instruction/getinstructionpayment","metadata":{"seo":{"title":"Get payments by instruction","description":"Returns the list of individual payments linked to an instruction identified by instructionId under the given clientId. Each payment record includes its id, destination account, amount, optional clientRef, current status (such as new or completed), and any explanatory reason or reasonCode. Use this endpoint to monitor execution and settlement of all payments created within a given payment instruction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstructionPayment","name":"Get payments by instruction","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instruction~1{instructionId}~1payment/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payments by instruction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of individual payments linked to an instruction identified by instructionId under the given clientId.\nEach payment record includes its id, destination account, amount, optional clientRef, current status (such as new or completed), and any explanatory reason or reasonCode. Use this endpoint to monitor execution and settlement of all payments created within a given payment instruction.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"instructionId","in":"path","schemaId":"schema_42","description":"The ID of requested instruction.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instruction~1{instructionId}~1payment/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/instruction/{instructionId}/payment","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"instructionId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/instruction/{instructionId}/payment","href":"instruction/getinstructionpayment","openApiOperationId":"getInstructionPayment","summary":"Get payments by instruction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of payments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73"}},"schemaId":"schema_73"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instruction~1{instructionId}~1payment/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_73","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instruction/getinstructionpayment"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/instruction/{instructionId}/payment"},{"label":"Get payment instruction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/instruction/getpaymentinstruction","routeSlug":"/openapi/api/instruction/getpaymentinstruction","metadata":{"seo":{"title":"Get payment instruction","description":"Returns the full payment instruction identified by instructionId under the given clientId. The response includes the instruction id, a list of scheduled payments (each with amount, target account, and optional clientRef), any bankTransferRef provided by the payment system, and the current status (such as new, processing, or completed). Use this endpoint to track the overall lifecycle and settlement state of a particular payment instruction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentInstruction","name":"Get payment instruction","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instruction~1{instructionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment instruction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the full payment instruction identified by instructionId under the given clientId. The response includes the instruction id, a list of scheduled payments (each with amount, target account, and optional clientRef), any bankTransferRef provided by the payment system, and the current status (such as new, processing, or completed). Use this endpoint to track the overall lifecycle and settlement state of a particular payment instruction.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"instructionId","in":"path","schemaId":"schema_42","description":"The ID of requested instruction.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instruction~1{instructionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/instruction/{instructionId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"instructionId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/instruction/{instructionId}","href":"instruction/getpaymentinstruction","openApiOperationId":"getPaymentInstruction","summary":"Get payment instruction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Instruction of payments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paymentInstruction"}},"schemaId":"components/schemas/paymentInstruction"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1instruction~1{instructionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/paymentInstruction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/paymentInstruction"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instruction/getpaymentinstruction"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/instruction/{instructionId}"}],"content":{"contentType":"group","meta":{"name":"Instruction"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Instructions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment instructions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., autogiro) batch one or more payments to accounts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create instructions, then track the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under each instruction (amounts, status, and references)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client/{clientId}/instruction/payment","summary":"Create payment instruction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/instruction/createpaymentinstruction","deprecated":false},{"title":"/v2/partner/client/{clientId}/instruction/{instructionId}/payment","summary":"Get payments by instruction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instruction/getinstructionpayment","deprecated":false},{"title":"/v2/partner/client/{clientId}/instruction/{instructionId}","summary":"Get payment instruction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instruction/getpaymentinstruction","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/openapi/api/order","routeSlug":"/openapi/api/order","items":[{"label":"Create order withdrawal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/order/createorderwithdrawal","routeSlug":"/openapi/api/order/createorderwithdrawal","metadata":{"seo":{"title":"Create order withdrawal","description":"Sell fund units and withdraw the resulting amount"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrderWithdrawal","name":"Create order withdrawal","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1withdrawal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create order withdrawal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sell fund units and withdraw the resulting amount"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1withdrawal/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate-only","in":"query","schemaId":"schema_62","description":"Only validate the order, do not create it.\n","example":"true"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1withdrawal/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/orderWithdrawal"}},"schemaId":"components/schemas/orderWithdrawal","pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1withdrawal/post/requestBody","description":"An order request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/partner/client/{clientId}/order/withdrawal","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"validate-only","in":"query","required":false,"example":"true","schemaId":"schema_62"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/orderWithdrawal"}},"responseCodes":["204","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/order/withdrawal","href":"order/createorderwithdrawal","openApiOperationId":"createOrderWithdrawal","summary":"Create order withdrawal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"schemaId":"components/schemas/orderWithdrawal","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/orderWithdrawal"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/orderResponse"}},"schemaId":"components/schemas/orderResponse"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1withdrawal/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"components/schemas/orderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/orderResponse"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/createorderwithdrawal"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/order/withdrawal"},{"label":"Create redemption transfer order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/order/createorderredemptiontransfer","routeSlug":"/openapi/api/order/createorderredemptiontransfer","metadata":{"seo":{"title":"Create redemption transfer order","description":"Sell fund units and transfer the resulting cash to another Fondo account belonging to the same client and owner. The redeemed amount settles on the source account first and is then transferred to the target account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrderRedemptionTransfer","name":"Create redemption transfer order","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1redemptionTransfer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create redemption transfer order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sell fund units and transfer the resulting cash to another Fondo\naccount belonging to the same client and owner. The redeemed amount\nsettles on the source account first and is then transferred to the\ntarget account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1redemptionTransfer/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate-only","in":"query","schemaId":"schema_62","description":"Only validate the order, do not create it.\n","example":"true"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1redemptionTransfer/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/orderRedemptionTransfer"}},"schemaId":"components/schemas/orderRedemptionTransfer","pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1redemptionTransfer/post/requestBody","description":"A redemption order that transfers proceeds to another internal account"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/partner/client/{clientId}/order/redemptionTransfer","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"validate-only","in":"query","required":false,"example":"true","schemaId":"schema_62"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/orderRedemptionTransfer"}},"responseCodes":["204","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/order/redemptionTransfer","href":"order/createorderredemptiontransfer","openApiOperationId":"createOrderRedemptionTransfer","summary":"Create redemption transfer order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"schemaId":"components/schemas/orderRedemptionTransfer","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/orderRedemptionTransfer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/orderResponse"}},"schemaId":"components/schemas/orderResponse"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1redemptionTransfer/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"components/schemas/orderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/orderResponse"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/createorderredemptiontransfer"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/order/redemptionTransfer"},{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/order/getorders","routeSlug":"/openapi/api/order/getorders","metadata":{"seo":{"title":"List orders","description":"Returns every order placed under clientId, including both subscriptions and redemptions. Each order object provides its id, orderType, current status (e.g., received, sent, confirmed, settled), associated account, references (clientRef, executorRef), the targeted instrument, requested units or amount, and full lifecycle timestamps (createdDate, modifiedDate, canceledDate). Use this endpoint to monitor all fund orders and their progress from initiation through settlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrders","name":"List orders","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns every order placed under clientId, including both subscriptions and redemptions.\nEach order object provides its id, orderType, current status (e.g., received, sent, confirmed, settled), associated account, references (clientRef, executorRef), the targeted instrument, requested units or amount, and full lifecycle timestamps (createdDate, modifiedDate, canceledDate).\nUse this endpoint to monitor all fund orders and their progress from initiation through settlement.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortedId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for pagination."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_44","description":"Limit results. Default is none\n"},{"name":"modifiedFrom","in":"query","schemaId":"schema_45","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modifiedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for reconciliation."},"children":[]}]}]}]},{"name":"ssn","in":"query","schemaId":"schema_46","description":"The social security number of account owner\n"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/order","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"start","in":"query","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","schemaId":"schema_43"},{"name":"limit","in":"query","example":100,"schemaId":"schema_44"},{"name":"modifiedFrom","in":"query","example":"2024-01-01T00:00:01.000Z","schemaId":"schema_45"},{"name":"ssn","in":"query","schemaId":"schema_46"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/order","href":"order/getorders","openApiOperationId":"getOrders","summary":"List orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of orders","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_74"}},"schemaId":"schema_74"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_74","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_74"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/getorders"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/order"},{"label":"Create order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/order/createorder","routeSlug":"/openapi/api/order/createorder","metadata":{"seo":{"title":"Create order","description":"Creates a new fund order (subscription or redemption) on the account specified by account under the given clientId. Provide details such as orderType, instrument, amount or units, and optional references (clientRef, executorRef) to help track the order. The response includes the generated order id, its initial status (typically received), and full order details for monitoring as it moves through execution and settlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrder","name":"Create order","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new fund order (subscription or redemption) on the account specified by account under the given clientId.\nProvide details such as orderType, instrument, amount or units, and optional references (clientRef, executorRef) to help track the order.\nThe response includes the generated order id, its initial status (typically received), and full order details for monitoring as it moves through execution and settlement.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validate-only","in":"query","schemaId":"schema_62","description":"Only validate the order, do not create it.\n","example":"true"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/order_request"}},"schemaId":"components/schemas/order_request","pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order/post/requestBody","description":"An order request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/partner/client/{clientId}/order","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"validate-only","in":"query","required":false,"example":"true","schemaId":"schema_62"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/order_request"}},"responseCodes":["204","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/order","href":"order/createorder","openApiOperationId":"createOrder","summary":"Create order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"schemaId":"components/schemas/order_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/order_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/orderResponse"}},"schemaId":"components/schemas/orderResponse"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"components/schemas/orderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/orderResponse"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/createorder"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/order"},{"label":"Get order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/order/getorderbyid","routeSlug":"/openapi/api/order/getorderbyid","metadata":{"seo":{"title":"Get order","description":"Returns the full details of a single order identified by orderId under the given clientId. The response includes the order's status (for example received, sent, confirmed, settled), orderType (subscription or redemption), associated account, instrument details, requested amount or units, and lifecycle timestamps (createdDate, modifiedDate, canceledDate). Use this endpoint to track an individual order's progress from initiation through settlement or cancellation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderById","name":"Get order","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1{orderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the full details of a single order identified by orderId under the given clientId.\nThe response includes the order's status (for example received, sent, confirmed, settled), orderType (subscription or redemption), associated account, instrument details, requested amount or units, and lifecycle timestamps (createdDate, modifiedDate, canceledDate).\nUse this endpoint to track an individual order's progress from initiation through settlement or cancellation.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"orderId","in":"path","schemaId":"schema_42","description":"The ID of requested order.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1{orderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/order/{orderId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"orderId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/order/{orderId}","href":"order/getorderbyid","openApiOperationId":"getOrderById","summary":"Get order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/orderResponse"}},"schemaId":"components/schemas/orderResponse"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1{orderId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/orderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/orderResponse"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/getorderbyid"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/order/{orderId}"},{"label":"Cancel order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/order/cancelorder","routeSlug":"/openapi/api/order/cancelorder","metadata":{"seo":{"title":"Cancel order","description":"Cancels the order identified by orderId for the given clientId. Use this endpoint to stop an order that has been created but not yet fully executed or settled. The response returns the complete order object with its status updated to canceled (if the cancellation succeeded), including all key fields such as orderType, instrument, and lifecycle timestamps."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelOrder","name":"Cancel order","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1{orderId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels the order identified by orderId for the given clientId.\nUse this endpoint to stop an order that has been created but not yet fully executed or settled.\nThe response returns the complete order object with its status updated to canceled (if the cancellation succeeded), including all key fields such as orderType, instrument, and lifecycle timestamps.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"orderId","in":"path","schemaId":"schema_42","description":"The ID of requested order.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1{orderId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/partner/client/{clientId}/order/{orderId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"orderId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/order/{orderId}","href":"order/cancelorder","openApiOperationId":"cancelOrder","summary":"Cancel order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/orderResponse"}},"schemaId":"components/schemas/orderResponse"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1order~1{orderId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/orderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/orderResponse"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/cancelorder"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/order/{orderId}"}],"content":{"contentType":"group","meta":{"name":"Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fund orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (subscription/redemption) drive the trading lifecycle."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create, read, list, and cancel orders; track status from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders reference "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instruments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and map to cash/fund transactions on settlement."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client/{clientId}/order/withdrawal","summary":"Create order withdrawal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/createorderwithdrawal","deprecated":false},{"title":"/v2/partner/client/{clientId}/order/redemptionTransfer","summary":"Create redemption transfer order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/createorderredemptiontransfer","deprecated":false},{"title":"/v2/partner/client/{clientId}/order","summary":"List orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/getorders","deprecated":false},{"title":"/v2/partner/client/{clientId}/order","summary":"Create order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/createorder","deprecated":false},{"title":"/v2/partner/client/{clientId}/order/{orderId}","summary":"Get order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/getorderbyid","deprecated":false},{"title":"/v2/partner/client/{clientId}/order/{orderId}","summary":"Cancel order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order/cancelorder","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/openapi/api/transaction","routeSlug":"/openapi/api/transaction","items":[{"label":"List cash transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/transaction/getcashtransactions","routeSlug":"/openapi/api/transaction/getcashtransactions","metadata":{"seo":{"title":"List cash transactions","description":"Returns every cash movement across all accounts belonging to the specified clientId. Each transaction includes its id, transactionType (e.g. deposit, withdrawal, or cash leg of a fund order), linked references (ref, refType, clientRef, executorRef), debit and credit accounts, monetary details (amount, currency), and full lifecycle timestamps (createdDate, modifiedDate, settlementDate). Use this endpoint to audit or reconcile every cash inflow and outflow associated with the client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCashTransactions","name":"List cash transactions","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1cash/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cash transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns every cash movement across all accounts belonging to the specified clientId. Each transaction includes its id, transactionType (e.g. deposit, withdrawal, or cash leg of a fund order), linked references (ref, refType, clientRef, executorRef), debit and credit accounts, monetary details (amount, currency), and full lifecycle timestamps (createdDate, modifiedDate, settlementDate). Use this endpoint to audit or reconcile every cash inflow and outflow associated with the client.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1cash/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortedId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for pagination."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_44","description":"Limit results. Default is none\n"},{"name":"modifiedFrom","in":"query","schemaId":"schema_45","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modifiedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for reconciliation."},"children":[]}]}]}]},{"name":"ref","in":"query","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match transactions to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ref"},"children":[]}]}]}]},{"name":"reftype","in":"query","schemaId":"schema_76","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match transactions "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reftype"},"children":[]}]}]}]},{"name":"ssn","in":"query","schemaId":"schema_46","description":"The social security number of account owner\n"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1cash/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/transaction/cash","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"start","in":"query","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","schemaId":"schema_43"},{"name":"limit","in":"query","example":100,"schemaId":"schema_44"},{"name":"modifiedFrom","in":"query","example":"2024-01-01T00:00:01.000Z","schemaId":"schema_45"},{"name":"ref","in":"query","example":"de9b6d5e-bda0-44f6-9193-f241014f18d5","schemaId":"schema_75"},{"name":"reftype","in":"query","example":"subscription","schemaId":"schema_76"},{"name":"ssn","in":"query","schemaId":"schema_46"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/transaction/cash","href":"transaction/getcashtransactions","openApiOperationId":"getCashTransactions","summary":"List cash transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of cash transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}},"schemaId":"schema_60"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1cash/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_60","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/getcashtransactions"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/transaction/cash"},{"label":"Get cash transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/transaction/getcashtransactionbyid","routeSlug":"/openapi/api/transaction/getcashtransactionbyid","metadata":{"seo":{"title":"Get cash transaction","description":"Returns the full record of a single cash movement identified by transactionId for the given clientId. The response provides all key properties—transactionType (deposit, withdrawal, or cash leg of a fund order), linked references (ref, refType, clientRef, executorRef), debit and credit accounts, amount, currency, optional free text, and full lifecycle timestamps (createdDate, modifiedDate, settlementDate). Use this endpoint to inspect or audit an individual cash transaction in detail."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCashTransactionById","name":"Get cash transaction","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1cash~1{transactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cash transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the full record of a single cash movement identified by transactionId for the given clientId. The response provides all key properties—transactionType (deposit, withdrawal, or cash leg of a fund order), linked references (ref, refType, clientRef, executorRef), debit and credit accounts, amount, currency, optional free text, and full lifecycle timestamps (createdDate, modifiedDate, settlementDate). Use this endpoint to inspect or audit an individual cash transaction in detail."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_42","description":"The ID of requested transaction.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1cash~1{transactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/transaction/cash/{transactionId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"transactionId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/transaction/cash/{transactionId}","href":"transaction/getcashtransactionbyid","openApiOperationId":"getCashTransactionById","summary":"Get cash transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cash transaction","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cashTransaction"}},"schemaId":"components/schemas/cashTransaction"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1cash~1{transactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/cashTransaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cashTransaction"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/getcashtransactionbyid"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/transaction/cash/{transactionId}"},{"label":"List fund transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/transaction/getfundtransactions","routeSlug":"/openapi/api/transaction/getfundtransactions","metadata":{"seo":{"title":"List fund transactions","description":"Returns every fund‐unit movement across the accounts of the specified clientId, including both subscriptions and redemptions. Each transaction details its transactionType (e.g. subscription, redemption), linked references (ref, refType, clientRef, executorRef), target account, instrument identifiers, number of units, executed price, currency, and full lifecycle timestamps (createdDate, modifiedDate, tradeDate, settlementDate). Use this endpoint to audit or reconcile all fund‐unit inflows and outflows associated with the client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFundTransactions","name":"List fund transactions","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1fund/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List fund transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns every fund‐unit movement across the accounts of the specified clientId, including both subscriptions and redemptions. Each transaction details its transactionType (e.g. subscription, redemption), linked references (ref, refType, clientRef, executorRef), target account, instrument identifiers, number of units, executed price, currency, and full lifecycle timestamps (createdDate, modifiedDate, tradeDate, settlementDate). Use this endpoint to audit or reconcile all fund‐unit inflows and outflows associated with the client."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1fund/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortedId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for pagination."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_44","description":"Limit results. Default is none\n"},{"name":"modifiedFrom","in":"query","schemaId":"schema_45","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modifiedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start from. Use for reconciliation."},"children":[]}]}]}]},{"name":"ref","in":"query","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match transactions to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ref"},"children":[]}]}]}]},{"name":"reftype","in":"query","schemaId":"schema_76","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match transactions "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reftype"},"children":[]}]}]}]},{"name":"ssn","in":"query","schemaId":"schema_46","description":"The social security number of account owner\n"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1fund/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/transaction/fund","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[{"name":"start","in":"query","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","schemaId":"schema_43"},{"name":"limit","in":"query","example":100,"schemaId":"schema_44"},{"name":"modifiedFrom","in":"query","example":"2024-01-01T00:00:01.000Z","schemaId":"schema_45"},{"name":"ref","in":"query","example":"de9b6d5e-bda0-44f6-9193-f241014f18d5","schemaId":"schema_75"},{"name":"reftype","in":"query","example":"subscription","schemaId":"schema_76"},{"name":"ssn","in":"query","schemaId":"schema_46"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/transaction/fund","href":"transaction/getfundtransactions","openApiOperationId":"getFundTransactions","summary":"List fund transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of fund transactions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1fund/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/getfundtransactions"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/transaction/fund"},{"label":"Get fund transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/transaction/getfundtransactionbyid","routeSlug":"/openapi/api/transaction/getfundtransactionbyid","metadata":{"seo":{"title":"Get fund transaction","description":"Returns the complete record of a single fund‐unit movement identified by transactionId for the given clientId. The response includes the transactionType (subscription or redemption), related references (ref, refType, clientRef, executorRef), account and instrument identifiers, number of units, executed price, currency, and full lifecycle timestamps (createdDate, modifiedDate, tradeDate, settlementDate). Use this endpoint to inspect or audit an individual subscription or redemption transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFundTransactionById","name":"Get fund transaction","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1fund~1{transactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get fund transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the complete record of a single fund‐unit movement identified by transactionId for the given clientId. The response includes the transactionType (subscription or redemption), related references (ref, refType, clientRef, executorRef), account and instrument identifiers, number of units, executed price, currency, and full lifecycle timestamps (createdDate, modifiedDate, tradeDate, settlementDate). Use this endpoint to inspect or audit an individual subscription or redemption transaction."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true},{"name":"transactionId","in":"path","schemaId":"schema_42","description":"The ID of requested transaction.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1fund~1{transactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/transaction/fund/{transactionId}","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"},{"name":"transactionId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","500","503"],"pointer":"/v2/partner/client/{clientId}/transaction/fund/{transactionId}","href":"transaction/getfundtransactionbyid","openApiOperationId":"getFundTransactionById","summary":"Get fund transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Fund transaction","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fundTransaction"}},"schemaId":"components/schemas/fundTransaction"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1transaction~1fund~1{transactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/fundTransaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fundTransaction"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/getfundtransactionbyid"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/transaction/fund/{transactionId}"}],"content":{"contentType":"group","meta":{"name":"Transaction"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" record movements of money and units."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash transactions (CT):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" deposits, withdrawals, cash legs of fund orders (with settlement dates)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fund transactions (FT):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unit movements from subscriptions/redemptions (trade & settlement dates)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to reconcile ledgers and statements."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client/{clientId}/transaction/cash","summary":"List cash transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction/getcashtransactions","deprecated":false},{"title":"/v2/partner/client/{clientId}/transaction/cash/{transactionId}","summary":"Get cash transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction/getcashtransactionbyid","deprecated":false},{"title":"/v2/partner/client/{clientId}/transaction/fund","summary":"List fund transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction/getfundtransactions","deprecated":false},{"title":"/v2/partner/client/{clientId}/transaction/fund/{transactionId}","summary":"Get fund transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction/getfundtransactionbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriptions (WebSocket)","link":"/openapi/api/subscription","routeSlug":"/openapi/api/subscription","items":[{"label":"Open WebSocket connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/subscription/getwebsocket","routeSlug":"/openapi/api/subscription/getwebsocket","metadata":{"seo":{"title":"Open WebSocket connection","description":"This is a WebSocket endpoint, not a regular HTTP GET. A plain GET against this path returns 404. The client must perform the WebSocket opening handshake (Upgrade: websocket, Connection: Upgrade, Sec-WebSocket-Version: 13, Sec-WebSocket-Key). On success the server responds with 101 Switching Protocols and the connection is upgraded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebsocket","name":"Open WebSocket connection","isWebhook":false,"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1subscribe/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Open WebSocket connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a WebSocket endpoint, not a regular HTTP GET."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A plain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" against this path returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The client must perform the WebSocket opening handshake ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Upgrade: websocket"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Connection: Upgrade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sec-WebSocket-Version: 13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sec-WebSocket-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). On success the server responds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"101 Switching Protocols"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the connection is upgraded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to receive live updates (for example on orders, transactions, or journeys) without polling the REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wss://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scheme (TLS is required). The full URL is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wss://{host}/v2/partner/client/{clientId}/subscribe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wss://api.sandbox.fondo.se/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in sandbox."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscription/getwebsocket/request/authentication","deepLinkHash":"/subscription/getwebsocket#subscription/getwebsocket/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate the upgrade with the same OAuth2 bearer token used for REST requests, sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Browsers cannot set this header on the WebSocket handshake — partners should connect from a backend."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscription/getwebsocket/request/events","deepLinkHash":"/subscription/getwebsocket#subscription/getwebsocket/request/events"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once connected, the server pushes JSON-encoded events. Every event has an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; events that carry data also have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload.current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the newly created object."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload.current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the new state, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload.previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the prior state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload.previous"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the removed object."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hello"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sent once when the connection opens. Includes an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instanceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifying the server instance handling this connection; a different value on reconnect means you've been routed to a different instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"heartbeat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sent at regular intervals to keep the connection alive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"server_closing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sent shortly before the server initiates a graceful close (for example during a deploy), typically ~2 seconds ahead. Use this signal to open a parallel connection and switch over before the close. Not emitted for unplanned disconnects or the load balancer's hourly connection cap."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscription/getwebsocket/request/eventid-and-deduplication","deepLinkHash":"/subscription/getwebsocket#subscription/getwebsocket/request/eventid-and-deduplication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and deduplication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every data event ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") carries an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — an opaque UUID string that is unique per WebSocket message and deterministic across server instances. Use it to deduplicate when running parallel connections during reconnect: the same logical event delivered on both connections shares the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", even when the connections are routed to different server instances. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not set on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hello"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"heartbeat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"server_closing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which are per-connection control signals."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscription/getwebsocket/request/connection-lifetime","deepLinkHash":"/subscription/getwebsocket#subscription/getwebsocket/request/connection-lifetime"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connection lifetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upstream load balancer enforces a maximum lifetime of approximately one hour per connection. Expect a clean close at roughly "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connectTime + 3600s"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and reconnect on your side. The hourly cap has no heads-up — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"server_closing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only emitted for planned server shutdowns (for example deploys), not for the LB timer. To avoid missing events on the cap, open a parallel connection shortly before the hour expires, deduplicate using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then close the original."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/api-guide/subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-Time Events guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the event-type catalogue, code samples, and reconnection guidance."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_42","description":"The ID of requested client.\n","required":true}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1subscribe/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/partner/client/{clientId}/subscribe","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["101","400","401","403","404","500","503"],"pointer":"/v2/partner/client/{clientId}/subscribe","href":"subscription/getwebsocket","openApiOperationId":"getWebsocket","summary":"Open WebSocket connection"},"definitionSamples":[{"lang":"curl","source":"curl -i -N --http1.1 \\\n  -H \"Connection: Upgrade\" \\\n  -H \"Upgrade: websocket\" \\\n  -H \"Sec-WebSocket-Version: 13\" \\\n  -H \"Sec-WebSocket-Key: $(openssl rand -base64 16)\" \\\n  -H \"Authorization: Bearer <YOUR_TOKEN_HERE>\" \\\n  https://api.sandbox.fondo.se/v2/partner/client/<CLIENT_ID>/subscribe\n"},{"lang":"Node.js","source":"import WebSocket from 'ws';\n\nconst ws = new WebSocket(\n  'wss://api.sandbox.fondo.se/v2/partner/client/<CLIENT_ID>/subscribe',\n  { headers: { Authorization: 'Bearer <YOUR_TOKEN_HERE>' } },\n);\n\nws.on('open',    () => console.log('connected'));\nws.on('message', (data) => console.log(JSON.parse(data.toString())));\nws.on('close',   (code, reason) => console.log('closed', code, reason.toString()));\nws.on('error',   (err) => console.error(err));\n"},{"lang":"Go","source":"package main\n\nimport (\n    \"fmt\"\n    \"log\"\n    \"net/http\"\n\n    \"github.com/gorilla/websocket\"\n)\n\nfunc main() {\n    headers := http.Header{}\n    headers.Set(\"Authorization\", \"Bearer <YOUR_TOKEN_HERE>\")\n\n    url := \"wss://api.sandbox.fondo.se/v2/partner/client/<CLIENT_ID>/subscribe\"\n    conn, _, err := websocket.DefaultDialer.Dial(url, headers)\n    if err != nil {\n        log.Fatal(err)\n    }\n    defer conn.Close()\n\n    for {\n        _, msg, err := conn.ReadMessage()\n        if err != nil {\n            log.Println(\"done:\", err)\n            return\n        }\n        fmt.Printf(\"%s\\n\", msg)\n    }\n}\n"},{"lang":"C#","source":"using System;\nusing System.Net.WebSockets;\nusing System.Text;\nusing System.Threading;\nusing System.Threading.Tasks;\n\nclass Program\n{\n    static async Task Main()\n    {\n        using var ws = new ClientWebSocket();\n        ws.Options.SetRequestHeader(\"Authorization\", \"Bearer <YOUR_TOKEN_HERE>\");\n\n        var uri = new Uri(\"wss://api.sandbox.fondo.se/v2/partner/client/<CLIENT_ID>/subscribe\");\n        await ws.ConnectAsync(uri, CancellationToken.None);\n\n        var buffer = new byte[4096];\n        while (ws.State == WebSocketState.Open)\n        {\n            var result = await ws.ReceiveAsync(buffer, CancellationToken.None);\n            if (result.MessageType == WebSocketMessageType.Close) break;\n            Console.WriteLine(Encoding.UTF8.GetString(buffer, 0, result.Count));\n        }\n    }\n}\n"},{"lang":"Java","source":"import java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.WebSocket;\nimport java.util.concurrent.CompletionStage;\n\nHttpClient client = HttpClient.newHttpClient();\nWebSocket ws = client.newWebSocketBuilder()\n    .header(\"Authorization\", \"Bearer <YOUR_TOKEN_HERE>\")\n    .buildAsync(\n        URI.create(\"wss://api.sandbox.fondo.se/v2/partner/client/<CLIENT_ID>/subscribe\"),\n        new WebSocket.Listener() {\n          @Override\n          public CompletionStage<?> onText(WebSocket ws, CharSequence data, boolean last) {\n            System.out.println(data);\n            return WebSocket.Listener.super.onText(ws, data, last);\n          }\n        })\n    .join();\n"},{"lang":"Python","source":"import asyncio\nimport websockets\n\nasync def main():\n    url = \"wss://api.sandbox.fondo.se/v2/partner/client/<CLIENT_ID>/subscribe\"\n    headers = {\"Authorization\": \"Bearer <YOUR_TOKEN_HERE>\"}\n    async with websockets.connect(url, additional_headers=headers) as ws:\n        async for msg in ws:\n            print(msg)\n\nasyncio.run(main())\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"101","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WebSocket handshake accepted. The connection is upgraded and the server begins streaming JSON-encoded events. The schema below describes the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"frame payload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent over the established WebSocket — not an HTTP response body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event"}},"schemaId":"components/schemas/event"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"403","description":"Forbidden Error (Not in scope)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the path is requested without WebSocket upgrade headers. To open the channel, perform a WebSocket handshake instead of a plain HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1v2~1partner~1client~1{clientId}~1subscribe/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"101","schemaId":"components/schemas/event","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"403","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"404"},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/getwebsocket"}],"panels":[]}]},"httpPath":"/v2/partner/client/{clientId}/subscribe"}],"content":{"contentType":"group","meta":{"name":"Subscription"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions (WebSocket)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"real-time updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from Fondo without polling."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WebSocket:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" open a persistent stream for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"heartbeat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journey callbacks:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Fondo sends HTTP POST updates to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callbackUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you provide when creating a journey."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include replay/retry handling in your consumers."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/partner/client/{clientId}/subscribe","summary":"Open WebSocket connection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription/getwebsocket","deprecated":false}]}]}]}]}},{"type":"group","label":"System","link":"/openapi/api/system","routeSlug":"/openapi/api/system","items":[{"label":"Ping service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api/system/ping","routeSlug":"/openapi/api/system/ping","metadata":{"seo":{"title":"Ping service","description":"Simple health-check endpoint that replies with a { \"pong\": ... } JSON object. Use it to verify that the Fondo API is reachable and responsive before making production calls."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ping","name":"Ping service","isWebhook":false,"pointer":"/paths/~1ping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ping service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simple health-check endpoint that replies with a { \"pong\": ... } JSON object. Use it to verify that the Fondo API is reachable and responsive before making production calls."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ping","servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","500","503"],"pointer":"/ping","href":"system/ping","openApiOperationId":"ping","summary":"Ping service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pong response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"400","description":"Invalid request or paramaters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"503","description":"Service Unavailable Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"}],"pointer":"/paths/~1ping/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"400","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"500","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"503","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/system/ping"}],"panels":[]}]},"httpPath":"/ping"}],"content":{"contentType":"group","meta":{"name":"System"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"System","showPageActions":true},{"nodeType":"markdoc","content":"API Service functions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ping","summary":"Ping service","prefix":{"name":"get","color":"get"},"badges":[],"link":"/system/ping","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/accountValue":{"id":"components/schemas/accountValue","kind":"json-schema","title":"accountValue","data":{"$id":"/models/performance/account_value.yaml","type":"object","required":["marketValue"],"properties":{"marketValue":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total market value of the account — the sum of settled cash balance, settled position value, and pending subscription amounts."},"children":[]}]}]}],"example":215000}}}},"components/schemas/client":{"id":"components/schemas/client","kind":"json-schema","title":"client","data":{"$id":"/models/client/client_base.yaml","title":"client","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/id"},"sortedId":{"$ref":"#/components/schemas/ulid"},"displayName":{"type":"string","description":"Name of client as displayed in journeys","example":"Advise"},"name":{"type":"string","description":"Name of client","example":"Advise AB"},"bankAccounts":{"type":"array","description":"Bank account defintions based on fee type. No duplicate feeTypes allowed","uniqueItems":true,"items":{"$ref":"#/components/schemas/bank_account"}},"serviceTypes":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/service_type"}},"crn":{"$ref":"#/components/schemas/crn","description":"Company registration number"},"country":{"type":"string","description":"Two-letter country code","pattern":"^[A-Z][A-Z]$","example":"SE"},"permissions":{"type":"object","description":"Client permissions and capabilities","readOnly":true,"additionalProperties":false,"properties":{"allowAutogiro":{"type":"boolean","description":"Whether autogiro deposits are allowed for this client"},"allowSwishDeposits":{"type":"boolean","description":"Whether Swish deposits are allowed for this client"},"allowLegalEntity":{"type":"boolean","description":"Whether legal entity accounts are allowed for this client"},"allowEnrichedInstrument":{"type":"boolean","description":"Whether enriched instrument data is returned for this client"},"allowHistoricalFundPrice":{"type":"boolean","description":"Whether historical fund price data is available"},"allowedAccountCategories":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MiFID II investor classifications allowed for this client."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Professional investor (MiFID II)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Retail investor, protected by consumer protection regulations (MiFID II)"},"children":[]}]}]}]}],"items":{"type":"string","enum":["pro","retail"]}}}}}}},"components/schemas/patchClient":{"id":"components/schemas/patchClient","kind":"json-schema","title":"client","data":{"$id":"/models/client/patch_client.yaml","title":"client","type":"object","minProperties":1,"additionalProperties":false,"properties":{"displayName":{"type":"string","description":"Name of client as displayed in journeys","example":"Advise"},"name":{"type":"string","description":"Name of client","example":"Advise AB"},"bankAccounts":{"type":"array","description":"Bank account defintions based on fee type. No duplicate feeTypes allowed","uniqueItems":true,"items":{"$ref":"#/components/schemas/bank_account"}},"serviceTypes":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/service_type"}},"crn":{"$ref":"#/components/schemas/crn","description":"Company registration number. 10-digits."},"country":{"type":"string","description":"Two-letter country code","pattern":"^[A-Z][A-Z]$","example":"SE"}}}},"components/schemas/account":{"id":"components/schemas/account","kind":"json-schema","title":"account","data":{"$id":"/models/account/account.yaml","title":"account","type":"object","required":["name","accountType","serviceType","deleted","currency","clientId"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/id"},"sortedId":{"$ref":"#/components/schemas/ulid"},"ref":{"type":"string","maxLength":128,"description":"ref is a unique account number, based on\nepoch, length and Luhn. OCR length digit compliant.\n","example":"160367146695159"},"name":{"type":"string","description":"Name of account","example":"Spar"},"accountType":{"title":"Account type","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — ISK, investeringssparkonto"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Depot, fonddepå"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insurance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Endowment insurance, kapitalförsäkring. Requires the user to sign separately with the insurance provider."},"children":[]}]}]}]}],"enum":["isk","depot","insurance"]},"status":{"title":"Account status","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Account created, waiting for approval"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Account is open and operational"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Account application was rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Account is awaiting confirmation from the end customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Account is being closed; new orders, payments and withdrawals are not accepted"},"children":[]}]}]}]}],"enum":["pending","active","rejected","confirm","closing"]},"serviceType":{"title":"Account service type","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolioManagement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Portfolio management"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"investmentAdvise"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Investment advice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executionOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Execution only"},"children":[]}]}]}]}],"enum":["portfolioManagement","investmentAdvise","executionOnly"]},"owner":{"$ref":"#/components/schemas/account_owner"},"balance":{"type":"number","description":"Snapshot of cash amount on account","example":100},"amounts":{"type":"object","description":"Amounts on account","properties":{"deposited":{"type":"number","description":"Amount deposited to account","example":123.45},"withdrawn":{"type":"number","description":"Amount withdrawn from account","example":123.45}}},"positions":{"type":"array","description":"List of positions held","items":{"type":"object","properties":{"instrument":{"type":"string","description":"Instrument identifier"},"units":{"type":"number","description":"Number of units, including unsettled."},"unitsSettled":{"type":"number","description":"Number of units settled"},"value":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total value of the position (units * closePrice)"},"children":[]}]}]}]},"closePrice":{"type":["number","null"],"description":"Last published NAV (closing price) for the fund"},"gav":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Average acquisition value (Genomsnittligt Anskaffningsvärde)"},"children":[]}]}]}]}}}},"category":{"title":"Account category","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MiFID II investor classification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Professional investor (MiFID II)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Retail investor, protected by consumer protection regulations (MiFID II)"},"children":[]}]}]}]}],"enum":["pro","retail"]},"deleted":{"type":"boolean","description":"Is account deleted?"},"clientId":{"$ref":"#/components/schemas/uuid","description":"The ID of the client managing this account"},"bankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/payment_account"}},"currency":{"type":"string","description":"Three letter ISO currency code","pattern":"^[A-Z]{3}$","example":"SEK"},"createdDate":{"type":"string","format":"date-time","description":"Date when acocunt was created","example":"2018-12-13T23:59:00.001Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z","readOnly":true},"deletedDate":{"type":"string","format":"date-time","description":"Date when flagged as deleted","example":"2018-12-13T23:59:00.001Z","readOnly":true}}}},"components/schemas/agreementType":{"id":"components/schemas/agreementType","kind":"json-schema","title":"agreementType","data":{"$id":"/models/agreement/agreement_type.yaml","title":"agreementType","type":"object","required":["key","swe","createdDate"],"properties":{"key":{"type":"string","description":"Agreement type identifier","example":"account"},"swe":{"type":"string","description":"Swedish name for the agreement type","example":"Kontoavtal"},"createdDate":{"type":"string","format":"date-time","description":"Date when the agreement was created","example":"2024-03-15T12:00:00.000Z"}}}},"components/schemas/cashTransaction":{"id":"components/schemas/cashTransaction","kind":"json-schema","title":"cashTransaction","data":{"$id":"/models/transaction/cash_transaction.yaml","type":"object","title":"cashTransaction","description":"Cash Transaction","required":["transactionType","amount","currency","revision","aborted","sortedId","id"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/id"},"sortedId":{"$ref":"#/components/schemas/ulid"},"transactionType":{"title":"Cash transaction type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash transaction type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deposit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Deposit of cash to account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fxFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — FX fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"withdrawal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Withdrawal of cash from account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfer of cash to account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfer of cash from account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Subscription order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redemption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Redemption order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retrocession"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Retrocession cash amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insurance_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Tax for the insurance"},"children":[]}]}]}]}],"enum":["deposit","fxFee","withdrawal","transfer_in","transfer_out","subscription","redemption","retrocession","insurance_tax"]},"aborted":{"description":"Transaction has been aborted.","type":"boolean","default":false},"abortedReason":{"type":"string","description":"Error code or freetext explaining abort","example":"referenced_order_canceled"},"revision":{"$ref":"#/components/schemas/ulid"},"abortedDate":{"type":"string","format":"date-time","description":"Date when transaction was aborted","example":"2018-12-13T23:59:00.001Z","readOnly":true},"correctedBy":{"description":"If this value is set, the transaction has been corrected by the transaction referenced by the id.\nAny calculations must ignore transactions where correctedBy is set.\n","$ref":"#/components/schemas/id"},"correctedReason":{"type":"string","description":"Reason for the correction","example":"order_amount_adjusted"},"ref":{"type":"string","description":"Transaction reference. External id. 255 chars.","maxLength":255},"refType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of reference:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Text reference"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Reference is an ID of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Reference is an ID of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ca"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Reference is an ID of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ca"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (corporate action) object"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transaction between internal accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transaction between external accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Reference is an ID of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_oneoff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — One-off fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_ongoing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Ongoing fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transactional fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_performance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Performance fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Other fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Unspecified client fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"correction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Correction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Gift"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compensations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Compensations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inheritance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Inheritance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dividend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"donation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Donation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endowment_101"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Endowment 101"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Partner Fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fondo_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fondo Fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insurance_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Insurance Tax"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insurance_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Insurance Fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"riskpremia_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Riskpremia Fee"},"children":[]}]}]}]}],"enum":["text","order","payment","ca","internal","external","transfer","client_fee_oneoff","client_fee_ongoing","client_fee_transaction","client_fee_performance","client_fee_other","client_fee","correction","gift","compensations","inheritance","dividend","donation","endowment_101","partner_fee","fondo_fee","insurance_tax","insurance_fee","riskpremia_fee"]},"creditAccount":{"$ref":"#/components/schemas/uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID of credited (receiving) account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for transaction types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deposit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfer_in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrocession"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refundCancel"},"children":[]}]}]}]}]},"debitAccount":{"$ref":"#/components/schemas/uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID of debited (charged) account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for transaction types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"withdrawal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfer_out"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fxFee"},"children":[]}]}]}]}]},"amount":{"type":"number","description":"Transaction amount as a number","example":1.2},"currency":{"type":"string","description":"Three letter ISO currency code","pattern":"^[A-Z]{3}$","example":"SEK","enum":["SEK"],"default":"SEK"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"clientRef":{"$ref":"#/components/schemas/client_ref"},"freetext":{"type":"string","description":"Free text of transaction","example":"Hello world"},"instrument":{"type":"string","description":"Id of instrument if it is a transaction related to a specific instrument but not an order, ie retrocession","example":"SE0012193019SEK"},"startDate":{"type":"string","format":"date","description":"If a transaction is regarding a period of time\nUsed for retrocession transactionType\n"},"endDate":{"type":"string","format":"date","description":"If a transaction is regarding a period of time.\nUsed for retrocession transaction type.\n"},"createdDate":{"type":"string","format":"date-time","description":"Date when transaction was created","example":"2018-12-13t23:59:00.001z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13t23:59:00.001z","readOnly":true},"settlementDate":{"type":["string","null"],"format":"date-time","description":"Date when transaction was settled, null if not settled","example":"2018-12-13t23:59:00.001z","readOnly":true}}}},"components/schemas/fundTransaction":{"id":"components/schemas/fundTransaction","kind":"json-schema","title":"fundTransaction","data":{"$id":"/models/transaction/fund_transaction.yaml","type":"object","title":"fundTransaction","description":"An object representing a fund transaction","required":["transactionType","currency","account","units","identifier","instrument","id","sortedId","revision"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/id"},"sortedId":{"$ref":"#/components/schemas/ulid"},"transactionType":{"title":"Fund transaction type","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redemption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Units of a redemption order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Units of a subscription order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Units transferred to account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Units transferred out of account"},"children":[]}]}]}]}],"enum":["redemption","subscription","transfer_in","transfer_out"]},"aborted":{"description":"Transaction has been aborted.","type":"boolean","default":false},"abortedReason":{"type":"string","description":"Error code or freetext explaining abort","example":"referenced_order_canceled"},"correctedBy":{"description":"If this value is set, the transaction has been corrected by the transaction referenced by the id.\nAny calculations must ignore transactions where correctedBy is set.\n","$ref":"#/components/schemas/id"},"revision":{"$ref":"#/components/schemas/ulid"},"abortedDate":{"type":"string","format":"date-time","description":"Date when transaction was aborted","example":"2018-12-13T23:59:00.001Z","readOnly":true},"correctedReason":{"type":"string","description":"Reason for the correction","example":"order_amount_adjusted"},"ref":{"type":"string","description":"Reference ID of the object that caused the transaction (order, ca etc)"},"refType":{"type":"string","description":"Type that caused the transaction","enum":["order","ca","internal","external","transfer","gift","compensations","inheritance","dividend","endowment_101","text","correction"]},"account":{"$ref":"#/components/schemas/uuid","description":"UUID of account of transaction"},"instrument":{"type":"string","description":"Fondo instrument ID","example":"SE0012193019SEK"},"identifier":{"description":"ISIN code of fund instrument","type":"string","example":"SE0012193019"},"units":{"type":"number","description":"Transaction fund units"},"price":{"type":"number","description":"Transaction price per unit (NAV)"},"currency":{"type":"string","description":"Three letter ISO currency code of transaction","pattern":"^[A-Z]{3}$","example":"SEK"},"freetext":{"type":"string","description":"Free text of transaction","example":"Hello world"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"clientRef":{"$ref":"#/components/schemas/client_ref"},"createdDate":{"type":"string","format":"date-time","description":"date when created","example":"2018-12-13T23:59:00.001Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z","readOnly":true},"settlementDate":{"type":"string","format":"date-time","description":"Date when transaction was settled, null if not settled","example":"2018-12-13T23:59:00.001Z","readOnly":true},"tradeDate":{"type":"string","format":"date-time","description":"Trade date (date of pricing)","example":"2018-12-13T23:59:00.001Z","readOnly":true}}}},"components/schemas/transfer":{"id":"components/schemas/transfer","kind":"json-schema","title":"transfer","data":{"$id":"/models/transfer/transfer.yaml","type":"object","title":"transfer","required":["custodian","custodianRef","status","createdDate","modifiedDate"],"properties":{"custodian":{"type":"string","format":"uuid","description":"ID of the custodian the transfer originates from."},"custodianRef":{"type":"string","description":"Reference at the custodian (e.g. account number or case id)."},"status":{"type":"string","enum":["pending","sent","complete","canceled"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current state of the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfer not yet sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Sent to custodian."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfer payment received and cash transfers have been created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Cancelled for some reason."},"children":[]}]}]}]}]},"createdDate":{"type":"string","format":"date-time"},"modifiedDate":{"type":"string","format":"date-time"}}}},"components/schemas/orderResponse":{"id":"components/schemas/orderResponse","kind":"json-schema","title":"Order Response","data":{"$id":"/models/order/order.yaml","type":"object","title":"Order Response","description":"order","required":["status","id"],"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/uuid"},"status":{"title":"Order Status","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Received by the system"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Order is pending cut-off time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Order sent to external party / exchange"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Order is settled and completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Order is canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Order is put on hold"},"children":[]}]}]}]}],"enum":["received","pending","sent","settled","canceled","hold"]}}},{"$ref":"#/components/schemas/order_base"},{"properties":{"createdDate":{"type":"string","format":"date-time","description":"date when created","example":"2018-12-13T23:59:00.001Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z","readOnly":true},"cancelledDate":{"type":["string","null"],"default":null,"format":"date-time","description":"Date when cancelled","example":"2018-12-13T23:59:00.001Z","readOnly":true}}}]}},"components/schemas/custodian":{"id":"components/schemas/custodian","kind":"json-schema","title":"custodian","data":{"$id":"/models/custodian/custodian_base.yaml","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"UUID of custodian."},"name":{"type":"string","description":"Name of custodian"}}}},"components/schemas/order":{"id":"components/schemas/order","kind":"json-schema","title":"Order Response","data":{"$id":"/models/order/order.yaml","type":"object","title":"Order Response","description":"order","required":["status","id"],"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/uuid"},"status":{"title":"Order Status","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Received by the system"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Order is pending cut-off time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Order sent to external party / exchange"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Order is settled and completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Order is canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Order is put on hold"},"children":[]}]}]}]}],"enum":["received","pending","sent","settled","canceled","hold"]}}},{"$ref":"#/components/schemas/order_base"},{"properties":{"createdDate":{"type":"string","format":"date-time","description":"date when created","example":"2018-12-13T23:59:00.001Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z","readOnly":true},"cancelledDate":{"type":["string","null"],"default":null,"format":"date-time","description":"Date when cancelled","example":"2018-12-13T23:59:00.001Z","readOnly":true}}}]}},"components/schemas/paymentInstruction":{"id":"components/schemas/paymentInstruction","kind":"json-schema","title":"paymentInstruction","data":{"$id":"/models/payment/payment_instruction.yaml","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"type":{"description":"The type of instruction","type":"string","example":"autogiro"},"instructions":{"description":"Array of payment instructions","type":"array","items":{"type":"object","additionalProperties":false,"required":["amount","account","clientRef"],"properties":{"amount":{"description":"The amount of the payment","type":"number","example":110},"account":{"$ref":"#/components/schemas/id"},"clientRef":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client specified reference for keeping track of payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value is copied to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientRef"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of transactions"},"children":[]}]}]}],"type":"string"}}}},"bankTransferRef":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text to use in a bank transfer. Not applicable for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autogiro"},"children":[]}]}]}],"type":["string","null"],"example":"REF-12345"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Instruction created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payments are being created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payments have been created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The instruction was canceled"},"children":[]}]}]}]}],"enum":["new","executing","processed","error","canceled"]}}}},"components/schemas/orderWithdrawal":{"id":"components/schemas/orderWithdrawal","kind":"json-schema","title":"redemption order for withdrawal","data":{"$id":"/models/order/order_redemption_withdrawal.yaml","type":"object","description":"redemption order with withdrawal","title":"redemption order for withdrawal","required":["account","instrument","units","executorRef"],"properties":{"orderType":{"type":"string","enum":["redemption"]},"account":{"$ref":"#/components/schemas/uuid","description":"Account ID"},"clientRef":{"type":"string","description":"Client applied ref","example":"my_order_123"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"instrument":{"type":"string","example":"US64110L1061USD","description":"Fondo instrument ID"},"units":{"type":"number","example":1000,"description":"Number of units. 7 decimals"},"paymentAccount":{"$ref":"#/components/schemas/uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment account ID to create bank payout for. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: Use bankAccount instead."},"children":[]}]}]}]}],"deprecated":true},"bankAccount":{"$ref":"#/components/schemas/uuid","description":"Bank account ID to create bank payout for. Required."}}}},"components/schemas/orderRedemptionTransfer":{"id":"components/schemas/orderRedemptionTransfer","kind":"json-schema","title":"redemptionTransfer","data":{"$id":"/models/order/order_redemption_transfer.yaml","type":"object","description":"redemption order with cash transfer to another internal account","title":"redemptionTransfer","required":["account","instrument","units","executorRef","targetAccount"],"properties":{"account":{"$ref":"#/components/schemas/uuid","description":"Source account ID"},"clientRef":{"type":"string","description":"Client applied ref","example":"my_order_123"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"instrument":{"type":"string","example":"US64110L1061USD","description":"Fondo instrument ID"},"units":{"type":"number","example":1000,"description":"Number of units. 7 decimals"},"targetAccount":{"$ref":"#/components/schemas/uuid","description":"Target Fondo account ID to receive the redemption proceeds. Must\nbelong to the same client and owner as the source account, and have the\nsame accountType. Insurance accounts are not supported. The redeemed\namount settles on the source account first and is then transferred to\nthe target account.\n"}}}},"components/schemas/instrument":{"id":"components/schemas/instrument","kind":"json-schema","title":"instrument","data":{"oneOf":[{"$ref":"#/components/schemas/fund"}]}},"components/schemas/performance":{"id":"components/schemas/performance","kind":"json-schema","title":"performance","data":{"$id":"/models/performance/performance_entry.yaml","type":"object","required":["date","dayReturn","dayResult","cumulativeReturn"],"properties":{"date":{"type":"string","format":"date","description":"The date of the performance entry.","example":"2025-01-02"},"dayReturn":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The daily return as a decimal (e.g. 0.0032 = 0.32%)."},"children":[]}]}]}],"example":0.0032},"dayResult":{"type":"number","description":"The absolute SEK profit/loss for the day\n","example":120.12},"cumulativeReturn":{"type":"number","example":-0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cumulative return since account inception as a fraction (e.g. 0.05 means +5%)"},"children":[]}]}]}]}}}},"components/schemas/journey":{"id":"components/schemas/journey","kind":"json-schema","title":"journey","data":{"$id":"/models/journey/journey_base.yaml","title":"journey","type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Journey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a web journey for interacting with Fondo functionality, such as setting up an account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback at the partner will be called with status of the journey, such as when it is completed or aborted due to end-user decision or error."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback information will also be sent over websocket if active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope parameter can be any value and used to keep state on partners end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback will be retried for any other status code than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure it is Fondo calling the callback URL, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to match."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fondo will also provide the IP address used from Fondos side."},"children":[]}]}]}],"required":["journey","callbackUrl","scope"],"properties":{"type":{"x-internal":true,"description":"Type of journey.\nMirrors the journey.journeyType\n","type":"string"},"status":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Journey created but not yet opened by the end customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — End customer has opened the journey and is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — End customer aborted the journey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — An error occurred during the journey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Journey completed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Journey URL expired before completion"},"children":[]}]}]}]}],"oneOf":[{"description":"New, journey not yet activated","type":"string","readOnly":true,"enum":["new"],"title":"new"},{"description":"Pending, journey in progress","type":"string","readOnly":true,"enum":["pending"],"title":"pending"},{"description":"Canceled, end-user aborted","type":"string","readOnly":true,"enum":["canceled"],"title":"canceled"},{"description":"Expired, TTL exceeded","type":"string","readOnly":true,"enum":["expired"],"title":"expired"},{"description":"Error, an error occured during the journey","type":"string","readOnly":true,"enum":["error"],"title":"error"},{"description":"Complete, journey is completed","type":"string","readOnly":true,"enum":["complete"],"title":"complete"}]},"id":{"description":"The ID of web journey.","allOf":[{"$ref":"#/components/schemas/uuid"},{"readOnly":true}]},"clientId":{"description":"The ID of requested client.","allOf":[{"$ref":"#/components/schemas/uuid"},{"readOnly":true}]},"url":{"readOnly":true,"type":"string","description":"journey url","example":"https://webbo.fondo.se/dT7KlfoMrjOspMBvyAq2bvD8cSSAVZg50bAh8G8U6z4nNPRHAy"},"expiryDate":{"readOnly":true,"type":"string","format":"date-time","description":"Date when journey token is considered stale","example":"2018-12-13T23:59:00.001Z"},"journey":{"type":"object","required":["journeyType"],"oneOf":[{"$ref":"#/components/schemas/journey_sign_withdrawal"},{"$ref":"#/components/schemas/journey_create_legal_entity_account"},{"$ref":"#/components/schemas/journey_sign_submission"},{"$ref":"#/components/schemas/journey_add_bank_account"},{"$ref":"#/components/schemas/journey_kyc_renewal"},{"$ref":"#/components/schemas/journey_update_allocation_plan"},{"$ref":"#/components/schemas/journey_update_savings_plan"},{"$ref":"#/components/schemas/create_account"}]},"sortedId":{"$ref":"#/components/schemas/ulid","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Date when acocunt was created","example":"2018-12-13T23:59:00.001Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z","readOnly":true},"deleted":{"description":"True if the journey is deleted","type":"boolean","readOnly":true},"deletedDate":{"readOnly":true,"type":["string","null"],"format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z"},"submission":{"description":"optional submission id.\nMay be created in legal entity journeys.\nMay be fetched on separate GET /submission/:id route\n","oneOf":[{"$ref":"#/components/schemas/uuid"},{"type":"null"}]},"callbackUrl":{"type":"string","description":"URL that receives a POST request when the journey status changes to canceled, error, or complete.\nThe payload includes the journey id, status, and scope.\nMust use https in production.\n","example":"https://api.habibisfonder.se/v1/fondo/callback"},"redirectUrl":{"type":["string","null"],"description":"Passed to BankID as the redirect target after mobile signing completes.\nSet this to a deep link (e.g. customerApp:///) so BankID returns the user to your app instead of the webview.\nNot needed for web-only integrations.\n","example":"customerApp:///"},"completionRedirectUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL the browser is redirected to once the journey completes successfully."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be an http(s) URL or a custom-scheme deep link (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"myapp://done"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for native-app handoff."},"children":[]}]}]}],"example":"https://partner.example/onboarding-done"},"errorCode":{"readOnly":true,"type":["string","null"],"description":"Any errors occurring during journey"},"context":{"type":["string","null"],"description":"Where end-user exited the journey. On error on cancel, if applicable.","example":"createaccountsign"},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."},"result":{"type":["object","null"],"description":"Result of journey","oneOf":[{"title":"createAccount result","properties":{"journeyType":{"type":"string","enum":["createAccount"]},"account":{"description":"account created in journey","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of account"},"status":{"$ref":"#/components/schemas/status"},"accountType":{"$ref":"#/components/schemas/accountType"},"serviceType":{"$ref":"#/components/schemas/serviceType"}}},"bankAccounts":{"description":"Payment accounts registered with allocation plan or savings plan","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of payment account"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandate status of the payment account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Pending verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Active, ready for withdrawals"},"children":[]}]}]}]}],"type":"string","enum":["pending","rejected","active"]},"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}}},"transfers":{"description":"If transfers from other custodian was created, the results are provided here. One item per account.","type":"array","items":{"type":"object","properties":{"custodian":{"$ref":"#/components/schemas/uuid","description":"ID matching an institution."},"account":{"type":"string","description":"Account number at institution","example":"1223456789"}}}},"allocationPlan":{"description":"If an allocationPlan was created. The results are provided here\n","type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of allocation plan"},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of payment account"},"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}},"instruments":{"description":"Instrument allocations. The sum of all allocations must be exactly 100.","type":"array","example":[{"instrument":"SE0000810798SEK","allocation":100}],"items":{"$ref":"#/components/schemas/instrument_allocation_item"}}}},"savingsplan":{"description":"If a savings plan was created. The results are provided here\n","type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of savings plan"},"paymentAccountId":{"$ref":"#/components/schemas/uuid","description":"id of payment account used for autogiro"},"periodicity":{"type":"string","enum":["monthly"]},"day":{"type":"number","description":"Day of the month to allocate","minimum":1,"maximum":31},"instruments":{"description":"Instrument allocations with fixed amounts","type":"array","items":{"type":"object","properties":{"instrument":{"type":"string","description":"Instrument ID"},"amount":{"type":"number","description":"Amount in SEK","minimum":1}}}}}}}},{"title":"updateAllocationPlan result","properties":{"journeyType":{"type":"string","enum":["updateAllocationPlan"]},"allocationPlan":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/uuid","description":"Fondo account id"},"instruments":{"description":"Updated instrument allocations. The sum of all allocations must be exactly 100.","type":"array","items":{"$ref":"#/components/schemas/instrument_allocation_item"}},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of payment account"}}}}}}},{"title":"updateSavingsPlan result","properties":{"journeyType":{"type":"string","enum":["updateSavingsPlan"]},"savingsplan":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of savings plan"},"paymentAccountId":{"$ref":"#/components/schemas/uuid","description":"id of payment account used for autogiro"},"startDate":{"type":"string","format":"date-time","description":"Date when the savings plan starts"},"instruments":{"description":"Instrument allocations with fixed amounts","type":"array","items":{"type":"object","properties":{"instrument":{"type":"string","description":"Instrument ID"},"amount":{"type":"number","description":"Amount in SEK","minimum":1}}}}}}}},{"title":"signSubmission result","properties":{"journeyType":{"type":"string","enum":["signSubmission"]},"submission":{"type":"object","properties":{"submission":{"$ref":"#/components/schemas/uuid","description":"id of the signed submission"}}}}},{"title":"createLegalEntityAccount result","properties":{"journeyType":{"type":"string","enum":["createLegalEntityAccount"]},"submission":{"type":"object","properties":{"submission":{"$ref":"#/components/schemas/uuid","description":"id of the signed submission"}}}}},{"title":"kycRenewal result","additionalProperties":false,"properties":{"journeyType":{"type":"string","enum":["kycRenewal"]}}},{"title":"addBankAccount result","additionalProperties":false,"properties":{"journeyType":{"type":"string","enum":["addBankAccount"]}}}]}}}},"components/schemas/journeyCallback":{"id":"components/schemas/journeyCallback","kind":"json-schema","title":"Journey callback","data":{"$id":"/models/journey/journey_callback.yaml","title":"Journey callback","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback at the partner will be called with status of the journey, such as when it is completed or aborted due to end-user decision or error."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback information will also be sent over websocket if active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope parameter can be any value, BASE64 encoded, and used to keep state on partners end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback will be retried 10 times for any other status code than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure it is Fondo calling the callback URL, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to match."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fondo will also provide the Fondo source IP address."},"children":[]}]}]}],"oneOf":[{"title":"error","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"The ID of web journey."},"context":{"type":["string","null"],"description":"Where user exited the journey. On error on cancel, if applicable.","example":"createaccountsign"},"status":{"enum":["error"]},"error":{"type":"object","oneOf":[{"title":"createAccount","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — End-user related process aborted the journey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTH_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — End-user could not be authenticated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYC_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Know Your Customer related process aborted the journey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — An unspecified error occurred"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfer of fund units or cash had an error; account is rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SIGN_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Error during signing"},"children":[]}]}]}]}],"enum":["USER_ERROR","AUTH_ERROR","KYC_ERROR","OTHER_ERROR","TRANSFER_ERROR","SIGN_ERROR"]},"journeyType":{"type":"string","title":"createAccount","enum":["createAccount"]}}}],"description":"Any errors occurring during journey"},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."}}},{"title":"canceled","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"The ID of web journey."},"context":{"type":["string","null"],"description":"Where user exited the journey. On error on cancel, if applicable.","example":"createaccountsign"},"status":{"type":"string","title":"canceled","enum":["canceled"]},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."}}},{"title":"pending","properties":{"id":{"description":"The ID of web journey.","$ref":"#/components/schemas/uuid"},"status":{"type":"string","title":"pending","enum":["pending"]},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."}}},{"title":"expired","properties":{"id":{"description":"The ID of web journey.","$ref":"#/components/schemas/uuid"},"status":{"type":"string","title":"expired","enum":["expired"]},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."}}},{"title":"complete","properties":{"id":{"description":"The ID of web journey.","$ref":"#/components/schemas/uuid"},"status":{"type":"string","title":"complete","enum":["complete"]},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."},"result":{"type":"object","description":"Result of journey","oneOf":[{"title":"createAccount result","properties":{"journeyType":{"enum":["createAccount"]},"account":{"description":"account created in journey","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of account"},"status":{"$ref":"#/components/schemas/status"},"accountType":{"$ref":"#/components/schemas/accountType"},"serviceType":{"$ref":"#/components/schemas/serviceType"}}},"bankAccounts":{"description":"accounts registered with allocation plan or for withdrawal","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of payment account"},"status":{"$ref":"#/components/schemas/status-2"},"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}},"transfers":{"description":"If transfers from other custodian was created, the results are provded here. One item per account.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["cash"],"description":"Type of transfer"},"custodian":{"$ref":"#/components/schemas/uuid","description":"ID matching an institution."},"account":{"type":"string","description":"Account number at institution","example":"1223456789"}}}},"allocationPlan":{"description":"If an allocationPlan was created. The results are provided here\n","type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of allocation plan"},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of bank account"},"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}},"instruments":{"description":"Instrument allocations. The sum of all allocations must be exactly 100.","type":"array","example":[{"instrument":"SE0000810798SEK","allocation":100}],"items":{"type":"object","properties":{"instrument":{"description":"Instrument ID","type":"string","example":"SE0000810798SEK"},"allocation":{"type":"number","example":100,"description":"Allocation in percent for this instrument"}}}}}}}},{"title":"updateAllocationPlan","additionalProperties":false,"properties":{"journeyType":{"type":"string","title":"updateAllocationPlan","enum":["updateAllocationPlan"]},"allocationPlan":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/uuid","description":"Fondo account"},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of payment account"}}}}}}},{"title":"kycRenewal","additionalProperties":false,"properties":{"journeyType":{"type":"string","title":"kycRenewal","enum":["kycRenewal"]}}},{"title":"addBankAccount","additionalProperties":false,"properties":{"journeyType":{"type":"string","title":"addBankAccount","enum":["addBankAccount"]}}}]}}}]}},"components/schemas/allocationPlan":{"id":"components/schemas/allocationPlan","kind":"json-schema","title":"AllocationPlan","data":{"$id":"/models/allocationplan/allocation_plan_base.yaml","title":"AllocationPlan","type":"object","required":["id","account","instruments"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"ID of allocation plan"},"account":{"$ref":"#/components/schemas/uuid","description":"ID of account"},"bankAccount":{"$ref":"#/components/schemas/uuid","description":"ID of bank account"},"instruments":{"description":"Instrument allocations. The sum of all allocations must be exactly 100.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/instrument_allocation_item"}}}}},"components/schemas/savingsPlan":{"id":"components/schemas/savingsPlan","kind":"json-schema","title":"savingsPlan","data":{"$id":"/models/savingsplan/savingsplan.yaml","title":"savingsPlan","type":"object","required":["id","account","periodicity","instruments"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"ID of savings plan"},"account":{"$ref":"#/components/schemas/uuid","description":"Fondo account ID"},"bankAccount":{"$ref":"#/components/schemas/uuid","description":"Payment account ID used for autogiro"},"periodicity":{"type":"string","enum":["monthly"]},"day":{"type":"number","description":"Day of the month to charge","minimum":1,"maximum":31},"instruments":{"description":"Instrument allocations with fixed amounts","type":"array","items":{"type":"object","required":["instrument","amount"],"properties":{"instrument":{"type":"string","description":"Instrument ID"},"amount":{"type":"number","description":"Amount in SEK","minimum":1}}}}}}},"components/schemas/event":{"id":"components/schemas/event","kind":"json-schema","title":"event","data":{"description":"Event subscription object","title":"event","oneOf":[{"type":"object","title":"hello","properties":{"eventType":{"type":"string","enum":["hello"],"title":"hello","description":"Sent by the server when a connection is established"},"instanceId":{"type":"string","description":"Identifier for the server instance handling this connection. A different value on reconnect means the partner has been routed to a different instance.\n"}}},{"type":"object","title":"heartbeat","properties":{"eventType":{"type":"string","enum":["heartbeat"],"title":"heartbeat","description":"Heartbeat to keep connection alive"}}},{"type":"object","title":"server_closing","properties":{"eventType":{"type":"string","enum":["server_closing"],"title":"server_closing","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Heads-up that the server will close this connection shortly (typically ~2 seconds ahead), for example during a deploy. Open a parallel WebSocket connection immediately and switch over before the close arrives. Not emitted for unplanned disconnects (crashes, network faults) or the load balancer's hourly connection cap."},"children":[]}]}]}]}}},{"type":"object","title":"account.create","properties":{"eventType":{"type":"string","enum":["account.create"],"title":"account.create","description":"Account created"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/account"}}}}},{"type":"object","title":"account.update","properties":{"eventType":{"type":"string","enum":["account.update"],"title":"account.update","description":"Account updated"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/account"},"previous":{"$ref":"#/components/schemas/account"}}}}},{"type":"object","title":"account.delete","properties":{"eventType":{"type":"string","enum":["account.delete"],"title":"account.delete","description":"Account deleted"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"previous":{"$ref":"#/components/schemas/account"}}}}},{"type":"object","title":"client.update","properties":{"eventType":{"type":"string","enum":["client.update"],"title":"client.update","description":"client updated"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/client_base"},"previous":{"$ref":"#/components/schemas/client_base"}}}}},{"type":"object","title":"client.delete","properties":{"eventType":{"type":"string","enum":["client.delete"],"title":"client.delete","description":"client deleted"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"previous":{"$ref":"#/components/schemas/client_base"}}}}},{"type":"object","title":"cashTransaction.create","properties":{"eventType":{"type":"string","enum":["cashTransaction.create"],"title":"cashTransaction.create","description":"Cash transaction created"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/cash_transaction"}}}}},{"type":"object","title":"cashTransaction.update","properties":{"eventType":{"type":"string","enum":["cashTransaction.update"],"title":"cashTransaction.update","description":"Cash transaction updated"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/cash_transaction"},"previous":{"$ref":"#/components/schemas/cash_transaction"}}}}},{"type":"object","title":"cashTransaction.delete","properties":{"eventType":{"type":"string","enum":["cashTransaction.delete"],"title":"cashTransaction.delete","description":"Cash transaction deleted"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"previous":{"$ref":"#/components/schemas/cash_transaction"}}}}},{"type":"object","title":"fundTransaction.create","properties":{"eventType":{"type":"string","enum":["fundTransaction.create"],"title":"fundTransaction.create","description":"Fund transaction created"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/fund_transaction"}}}}},{"type":"object","title":"fundTransaction.update","properties":{"eventType":{"type":"string","enum":["fundTransaction.update"],"title":"fundTransaction.update","description":"Fund transaction updated"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/fund_transaction"},"previous":{"$ref":"#/components/schemas/fund_transaction"}}}}},{"type":"object","title":"fundTransaction.delete","properties":{"eventType":{"type":"string","enum":["fundTransaction.delete"],"title":"fundTransaction.delete","description":"Fund transaction deleted"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"previous":{"$ref":"#/components/schemas/fund_transaction"}}}}},{"type":"object","title":"order.create","properties":{"eventType":{"type":"string","enum":["order.create"],"title":"order.create","description":"order created"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/order"}}}}},{"type":"object","title":"order.update","properties":{"eventType":{"type":"string","enum":["order.update"],"title":"order.update","description":"order updated"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/order"},"previous":{"$ref":"#/components/schemas/order"}}}}},{"type":"object","title":"order.delete","properties":{"eventType":{"type":"string","enum":["order.delete"],"title":"order.delete","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order canceled (order status set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"previous":{"$ref":"#/components/schemas/order"}}}}},{"type":"object","title":"instrument.reloaded","properties":{"eventType":{"type":"string","enum":["instrument.reloaded"],"title":"instrument.reloaded","description":"Funds updated"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"reloaded":{"type":"boolean","enum":[true],"title":"reloaded"}}}}},{"type":"object","title":"journey.delete","properties":{"eventType":{"type":"string","enum":["journey.delete"],"title":"journey.delete","description":"journey deleted"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"previous":{"$ref":"#/components/schemas/journey_base"}}}}},{"type":"object","title":"journey.update","properties":{"eventType":{"type":"string","enum":["journey.update"],"title":"journey.update","description":"journey updated"},"eventId":{"$ref":"#/components/schemas/eventId"},"payload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/journey_base"},"previous":{"$ref":"#/components/schemas/journey_base"}}}}}],"$defs":{"eventId":{"type":"string","format":"uuid","description":"Opaque UUID identifier unique per WebSocket message, deterministic across server instances. Use for deduplication when running overlapping connections during reconnect.\n"}}}},"components/schemas/withdrawal":{"id":"components/schemas/withdrawal","kind":"json-schema","title":"redemption order for withdrawal","data":{"$id":"/models/order/order_redemption_withdrawal.yaml","type":"object","description":"redemption order with withdrawal","title":"redemption order for withdrawal","required":["account","instrument","units","executorRef"],"properties":{"orderType":{"type":"string","enum":["redemption"]},"account":{"$ref":"#/components/schemas/uuid","description":"Account ID"},"clientRef":{"type":"string","description":"Client applied ref","example":"my_order_123"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"instrument":{"type":"string","example":"US64110L1061USD","description":"Fondo instrument ID"},"units":{"type":"number","example":1000,"description":"Number of units. 7 decimals"},"paymentAccount":{"$ref":"#/components/schemas/uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment account ID to create bank payout for. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: Use bankAccount instead."},"children":[]}]}]}]}],"deprecated":true},"bankAccount":{"$ref":"#/components/schemas/uuid","description":"Bank account ID to create bank payout for. Required."}}}},"components/schemas/fund_transfer_request":{"id":"components/schemas/fund_transfer_request","kind":"json-schema","title":"fund_transfer_request","data":{"$id":"/models/transaction/fund_transfer_request.yaml","type":"object","description":"Fund Transfer","required":["debitAccount","creditAccount","units","instrumentId"],"additionalProperties":false,"properties":{"creditAccount":{"$ref":"#/components/schemas/uuid","description":"UUID of credited (receiving) account"},"debitAccount":{"$ref":"#/components/schemas/uuid","description":"UUID of debited (charged) account"},"units":{"type":"number","description":"Number of units to transfer"},"instrumentId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id (isin + currency) of instrument to transfer"},"children":[]}]}]}]}}}},"components/schemas/cash_transfer_request":{"id":"components/schemas/cash_transfer_request","kind":"json-schema","title":"cash_transfer_request","data":{"$id":"/models/transaction/cash_transfer_request.yaml","type":"object","description":"Cash Transfer","required":["amount","debitAccount","creditAccount"],"additionalProperties":false,"properties":{"creditAccount":{"$ref":"#/components/schemas/uuid","description":"UUID of credited (receiving) account"},"debitAccount":{"$ref":"#/components/schemas/uuid","description":"UUID of debited (charged) account"},"amount":{"type":"number","description":"Transaction amount"},"text":{"type":"string","description":"Text message"}}}},"components/schemas/fund_short":{"id":"components/schemas/fund_short","kind":"json-schema","title":"fund_short","data":{"$id":"/models/instrument/fund_short.yaml","type":"object","properties":{"id":{"type":"string","description":"slug"},"isincode":{"type":"string","example":"SE0001862426"},"name":{"type":"string","example":"Adrigo Hedge","description":"Name of fund"},"currency":{"type":"string","pattern":"^[a-zA-Z]{3}$","description":"Currency code of fund","example":"NOK"},"rebate":{"type":"number","description":"The rebate for this fund in percent","example":40},"calculatedRebate":{"type":"number","description":"Calculated rebate in percent","example":40},"isClean":{"type":"boolean"},"cost":{"type":"object","properties":{"total":{"type":"number"},"fx":{"type":"number"},"transaction_fee_actual":{"type":"number"},"ongoing_actual":{"type":"number"},"management_fee_actual":{"type":"number"},"performance_fee_actual":{"type":"number"},"transaction_fee_estimated":{"type":"number"},"ongoing_estimated":{"type":"number"},"management_fee_estimated":{"type":"number"},"performance_fee_estimated":{"type":"number"}}},"branding":{"type":"string","example":"Adrigo","description":"Branding name of fund"},"fundCompany":{"type":"object","properties":{"id":{"type":"string","description":"The id of the fund company"},"name":{"type":"string"},"adress":{"type":"string"},"postalcode":{"type":"string"},"phone":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"homepage":{"type":"string"}}}}}},"components/schemas/enriched_instruments":{"id":"components/schemas/enriched_instruments","kind":"json-schema","title":"enriched_instruments","data":{"$id":"/models/instrument/enriched_instruments.yaml","type":"array","items":{"$ref":"#/components/schemas/enriched_fund"}}},"components/schemas/enriched_fund":{"id":"components/schemas/enriched_fund","kind":"json-schema","title":"enriched_fund","data":{"$id":"/models/instrument/enriched_fund.yaml","type":"object","description":"Enriched instrument data including analytics and portfolio details","allOf":[{"$ref":"#/components/schemas/fund"},{"type":"object","properties":{"risk":{"type":"number","description":"Numeric risk score"},"riskLevel":{"type":"string","description":"Risk level category"},"sfdr":{"type":"number","description":"SFDR classification"},"category":{"type":"string","description":"Fund category"},"assetClass":{"type":"string","description":"Asset class classification"},"rating":{"type":"object","properties":{"name":{"type":"string","description":"Rating provider name"},"value":{"type":["number","null"],"description":"Rating value"}}},"performance":{"type":"object","properties":{"d1":{"type":"number"},"m0":{"type":"number"},"m1":{"type":"number"},"m3":{"type":"number"},"m6":{"type":"number"},"w1":{"type":"number"},"m12":{"type":"number"},"m36":{"type":"number"},"m60":{"type":"number"},"close":{"type":"number"}}},"sector":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"percent":{"type":"number"}}}},"regional":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"percent":{"type":"number"}}}},"holdings":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"percent":{"type":"number"},"externalName":{"type":"string"}}}},"fundCompany":{"type":"object","properties":{"id":{"type":"string","description":"The id of the fund company"}}},"strategy":{"type":"string","description":"Fund strategy description"},"pricingFrequency":{"type":"string","description":"Pricing frequency indicator"},"availableToRetail":{"type":["boolean","null"],"description":"Whether the fund is available to retail investors. Null when the\nprovider reports no investor type data.\n"},"availableToPro":{"type":["boolean","null"],"description":"Whether the fund is available to professional investors. Null when the\nprovider reports no investor type data.\n"},"inceptionDate":{"type":"string","format":"date","description":"Fund inception date"},"totalMarketValue":{"type":"array","description":"Total market value of the fund portfolio per currency","items":{"type":"object","properties":{"currency":{"type":"string"},"value":{"type":"number"}}}}}}]}},"components/schemas/fundPrices":{"id":"components/schemas/fundPrices","kind":"json-schema","title":"fundPrices","data":{"$id":"/models/instrument/fundPrices.yaml","type":"array","items":{"type":"object","properties":{"date":{"type":"string","description":"Date of price, YYYY-MM-DD","format":"date-time"},"value":{"type":"number","description":"Price"}}}}},"components/schemas/crn":{"id":"components/schemas/crn","kind":"json-schema","title":"crn","data":{"$id":"/models/crn.yaml","type":"string","minLength":10,"maxLength":10,"pattern":"\\d{10}","example":"5011121421"}},"components/schemas/ssn":{"id":"components/schemas/ssn","kind":"json-schema","title":"SSN (Social Security Number)","data":{"$id":"/models/ssn.yaml","title":"SSN (Social Security Number)","type":"string","pattern":"^(19|20)[0-9]{2}(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01])[0-9]{4}$","example":"197001010003"}},"components/schemas/deposit_response":{"id":"components/schemas/deposit_response","kind":"json-schema","title":"deposit_response","data":{"$id":"/models/payment/deposit_response.yaml","type":"object","required":["token"],"properties":{"id":{"type":"string","description":"A swish payment ID"},"token":{"type":"string","description":"A Swish APP token"}}}},"components/schemas/payment_instruction":{"id":"components/schemas/payment_instruction","kind":"json-schema","title":"payment_instruction","data":{"$id":"/models/payment/payment_instruction.yaml","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"type":{"description":"The type of instruction","type":"string","example":"autogiro"},"instructions":{"description":"Array of payment instructions","type":"array","items":{"type":"object","additionalProperties":false,"required":["amount","account","clientRef"],"properties":{"amount":{"description":"The amount of the payment","type":"number","example":110},"account":{"$ref":"#/components/schemas/id"},"clientRef":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client specified reference for keeping track of payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value is copied to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientRef"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of transactions"},"children":[]}]}]}],"type":"string"}}}},"bankTransferRef":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The text to use in a bank transfer. Not applicable for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autogiro"},"children":[]}]}]}],"type":["string","null"],"example":"REF-12345"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Instruction created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payments are being created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payments have been created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The instruction was canceled"},"children":[]}]}]}]}],"enum":["new","executing","processed","error","canceled"]}}}},"components/schemas/mandate":{"id":"components/schemas/mandate","kind":"json-schema","title":"mandate","data":{"$id":"/models/payment/mandate.yaml","type":"object","required":["paymentAccount","mandateType","status","ownerId","ssn"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"UUID of payment. Genereated automatically when created."},"mandateType":{"type":"string","enum":["autogiro"]},"ownerId":{"$ref":"#/components/schemas/uuid","description":"UUID of payment owner."},"ssn":{"type":"string","description":"Social Security Number"},"paymentAccount":{"$ref":"#/components/schemas/uuid","description":"UUID of associated paymentAccount"},"payerId":{"type":"string","description":"Payer identification","example":"00102030404"},"status":{"type":"string","enum":["new","pending","active","rejected","canceled","deleted"]},"signature":{"type":"string","description":"Signature by owner, for example BankID"},"createdDate":{"type":"string","format":"date-time","description":"Date when acocunt was created","example":"2018-12-13T23:59:00.001Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z"},"deletedDate":{"type":"string","format":"date-time","description":"Date if and when deleted","example":"2018-12-13T23:59:00.001Z"},"tags":{"type":"array","items":{"type":"string"},"description":"JSON tags"},"metadata":{"type":"object","description":"JSON metadata"}}}},"components/schemas/update_payment_account_request":{"id":"components/schemas/update_payment_account_request","kind":"json-schema","title":"update_payment_account_request","data":{"$id":"/models/payment/update_payment_account_request.yaml","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of account","example":"Lönekonto"},"tags":{"type":"array","items":{"type":"string"},"description":"JSON tags"},"metadata":{"type":"object","description":"JSON metadata"}}}},"components/schemas/post_payment_instruction":{"id":"components/schemas/post_payment_instruction","kind":"json-schema","title":"post_payment_instruction","data":{"$id":"/models/payment/post_payment_instruction.yaml","type":"object","required":["payments","type"],"additionalProperties":false,"properties":{"type":{"description":"The type of payment","enum":["autogiro"]},"payments":{"description":"Array of payment instructions","type":"array","items":{"type":"object","required":["amount","account","clientRef"],"properties":{"amount":{"description":"The amount of the payment","type":"number","example":110},"account":{"$ref":"#/components/schemas/id"},"clientRef":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client specified reference for keeping track of payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value is copied to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientRef"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of transactions"},"children":[]}]}]}],"example":"instruction_id_29384","type":"string"}}}}}}},"components/schemas/optional_account_categories":{"id":"components/schemas/optional_account_categories","kind":"json-schema","title":"Optional Account Categories","data":{"$id":"/models/shared/optional_account_categories.yaml","title":"Optional Account Categories","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MiFID II investor classification. If the client permissions allows both pro and retail customers, this must be set."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It must never exceed the permissions on the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Professional investor (MiFID II)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Retail investor, protected by consumer protection regulations (MiFID II)"},"children":[]}]}]}]}],"type":"array","items":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Professional investor (MiFID II)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Retail investor, protected by consumer protection regulations (MiFID II)"},"children":[]}]}]}]}],"enum":["pro","retail"]}}},"components/schemas/required_account_categories":{"id":"components/schemas/required_account_categories","kind":"json-schema","title":"Required Account Categories","data":{"$id":"/models/shared/required_account_categories.yaml","title":"Required Account Categories","type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MiFID II investor classification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Professional investor (MiFID II)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Retail investor, protected by consumer protection regulations (MiFID II)"},"children":[]}]}]}]}],"minItems":1,"items":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Professional investor (MiFID II)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Retail investor, protected by consumer protection regulations (MiFID II)"},"children":[]}]}]}]}],"enum":["pro","retail"]}}},"components/schemas/legal_entity_account_options":{"id":"components/schemas/legal_entity_account_options","kind":"json-schema","title":"Legal Entity Account Options","data":{"$id":"/models/shared/legal_entity_account_options.yaml","title":"Legal Entity Account Options","type":"object","description":"Application payload data for legal entity accounts","additionalProperties":false,"required":["accountTypes","serviceTypes","accountCategories","ownerType"],"properties":{"serviceTypes":{"type":"array","minItems":1,"items":{"type":"string","enum":["portfolioManagement","investmentAdvise","executionOnly"]}},"accountTypes":{"$ref":"#/components/schemas/legal_entity_account_types"},"accountCategories":{"$ref":"#/components/schemas/required_account_categories"},"ownerType":{"type":"string","enum":["legal_entity"]}}}},"components/schemas/journey_create_legal_entity_account":{"id":"components/schemas/journey_create_legal_entity_account","kind":"json-schema","title":"createLegalEntityAccount","data":{"$id":"/models/journey/journey_create_legal_entity_account.yaml","title":"createLegalEntityAccount","required":["accountOptions","journeyType"],"additionalProperties":false,"description":"Let end user complete an application process\n","properties":{"journeyType":{"type":"string","title":"createLegalEntityAccount","enum":["createLegalEntityAccount"]},"accountOptions":{"$ref":"#/components/schemas/legal_entity_account_options"}}}},"components/schemas/journey_sign_submission":{"id":"components/schemas/journey_sign_submission","kind":"json-schema","title":"signSubmission","data":{"$id":"/models/journey/journey_sign_submission.yaml","title":"signSubmission","required":["submission","ssn"],"additionalProperties":false,"description":"Let end user sign a submission\n","properties":{"submission":{"allOf":[{"$ref":"#/components/schemas/uuid"},{"description":"Fondo application. E.g. a legal-entity signing a new account\n"}]},"ssn":{"allOf":[{"$ref":"#/components/schemas/ssn"},{"description":"Social security number of signer"}]},"journeyType":{"type":"string","title":"signSubmission","enum":["signSubmission"]}}}},"components/schemas/journey_add_bank_account":{"id":"components/schemas/journey_add_bank_account","kind":"json-schema","title":"addBankAccount","data":{"$id":"/models/journey/journey_add_bank_account.yaml","title":"addBankAccount","required":["account","journeyType"],"additionalProperties":false,"description":"Let end-user connect bank account that will be\nvalidated (usable for withdrawals).\nOptionally: ask for autogiro-mandate.\nMandates have a lead time for at least one bank day\n","properties":{"account":{"allOf":[{"$ref":"#/components/schemas/uuid"},{"description":"Fondo account"}]},"autogiro":{"type":"object","required":["enforce"],"properties":{"enforce":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autogiro mandate signing requirement:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — End customer must sign an autogiro mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — End customer may choose to sign an autogiro mandate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — No autogiro mandate option is presented"},"children":[]}]}]}]}],"oneOf":[{"type":"string","enum":["required"],"title":"required","description":"User MUST sign autogiro mandate"},{"type":"string","enum":["optional"],"title":"optional","description":"User may choose to sign autogiro mandate"},{"type":"string","enum":["none"],"title":"none","description":"User have no option to sign autogiro mandate."}]},"forceNewBankAccount":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to false."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set to false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and autogiro enforce is set to required or optional,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the end-user may select an existing account to connect to autogiro"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of connecting a new account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set to true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and autogiro enforce is set to required or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional, force the end-user to connect a new bankAccount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"irrespective of if old accounts exists."},"children":[]}]}]}]}}},"journeyType":{"type":"string","title":"addBankAccount","enum":["addBankAccount"]}}}},"components/schemas/journey_kyc_renewal":{"id":"components/schemas/journey_kyc_renewal","kind":"json-schema","title":"kycRenewal","data":{"$id":"/models/journey/journey_kyc_renewal.yaml","title":"kycRenewal","required":["account","journeyType"],"additionalProperties":false,"properties":{"account":{"$ref":"#/components/schemas/uuid","description":"Fondo account"},"journeyType":{"type":"string","title":"kycRenewal","enum":["kycRenewal"]}}}},"components/schemas/journey_update_allocation_plan":{"id":"components/schemas/journey_update_allocation_plan","kind":"json-schema","title":"updateAllocationPlan","data":{"$id":"/models/journey/journey_update_allocation_plan.yaml","title":"updateAllocationPlan","required":["account","journeyType"],"additionalProperties":false,"properties":{"journeyType":{"type":"string","title":"updateAllocationPlan","enum":["updateAllocationPlan"]},"account":{"$ref":"#/components/schemas/uuid","description":"Fondo account"},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","required":["iban"],"properties":{"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}},"allocationPlan":{"type":"object","description":"The new allocation plan. If provided, replaces the existing instruments and allocations.","required":["instruments"],"properties":{"instruments":{"description":"Instrument allocations. The sum of all allocations must be exactly 100.","type":"array","example":[{"instrument":"SE0000810798SEK","allocation":100}],"items":{"$ref":"#/components/schemas/instrument_allocation_item"}}}}}}},"components/schemas/journey_create_account":{"id":"components/schemas/journey_create_account","kind":"json-schema","title":"createAccount","data":{"$id":"/models/journey/createAccount/create_account.yaml","title":"createAccount","required":["accountTypes","accountServiceType","journeyType"],"additionalProperties":false,"not":{"allOf":[{"required":["allocationPlan"],"properties":{"allocationPlan":{"type":"object"}}},{"required":["savingsPlan"],"properties":{"savingsPlan":{"type":"object"}}}]},"properties":{"journeyType":{"type":"string","title":"createAccount","enum":["createAccount"]},"welcomeScreen":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional custom welcome screen."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently only available when transfer is set."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only allowed in combination with populated transfer field"},"children":[]}]}]}]}],"type":"string","enum":["transfer"]},"email":{"type":["string","null"],"format":"email","description":"end user email address","example":"enduser@endUserDomain.com"},"accountName":{"type":"string","maxLength":500,"description":"If not provided, the end-user will be asked to select accountName. If provided, the accountName will not be visible to the customer in this journey."},"accountTypes":{"type":"array","description":"Allowed account types","items":{"enum":["isk","depot","insurance"]}},"accountServiceType":{"description":"Account service type","type":"string","title":"accountServiceType","enum":["portfolioManagement","investmentAdvise","executionOnly"]},"accountCategories":{"$ref":"#/components/schemas/optional_account_categories"},"allocationPlan":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setup an allocation plan for the account. Deposits will allocate based on this plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the view will not be shown"},"children":[]}]}]}],"type":["object","null"],"required":["instruments"],"properties":{"depositType":{"$ref":"#/components/schemas/deposit_type"},"periodicity":{"$ref":"#/components/schemas/periodicity"},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","properties":{"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}},"instruments":{"description":"Instrument allocations. The sum of all allocations must be exactly 100.","type":"array","example":[{"instrument":"SE0000810798SEK","allocation":100}],"items":{"$ref":"#/components/schemas/instrument_allocation_item"}}}},"savingsPlan":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable savings plan setup during account creation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User will configure instruments and amounts in the UI."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the view will not be shown."},"children":[]}]}]}],"type":["object","null"],"required":["periodicity"],"properties":{"periodicity":{"type":"string","enum":["monthly"]},"instruments":{"description":"Instruments available for the savings plan.\nIf omitted, the end user may choose from all instruments in the client universe.\n","type":"array","items":{"type":"object","required":["instrument"],"additionalProperties":false,"properties":{"instrument":{"type":"string","description":"Instrument ID"}}}}}},"kycs":{"description":"Valid Know Your Customer answers used to prefill the options in the journey.","type":["array","null"],"items":{"type":"object","required":["qid","answer"],"properties":{"qid":{"description":"Fondo ID of the question","example":"money_origin","type":"string"},"answer":{"description":"Answer","example":"lön/pension","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array"},{"type":"object"}]}}}},"transfer":{"$ref":"#/components/schemas/transfer-2"}}}},"components/schemas/journey_post":{"id":"components/schemas/journey_post","kind":"json-schema","title":"Create Journey Request","data":{"$id":"/models/journey/journey_post.yaml","title":"Create Journey Request","type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Journey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a web journey for interacting with Fondo functionality, such as setting up an account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback at the partner will be called with status of the journey, such as when it is completed or aborted due to end-user decision or error."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback information will also be sent over websocket if active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope parameter can be any value and used to keep state on partners end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback will be retried for any other status code than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure it is Fondo calling the callback URL, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to match."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fondo will also provide the IP address used from Fondos side."},"children":[]}]}]}],"required":["journey","callbackUrl","scope"],"properties":{"type":{"x-internal":true,"description":"Type of journey.\nMirrors the journey.journeyType\n","type":"string"},"journey":{"type":"object","required":["journeyType"],"discriminator":{"propertyName":"journeyType"},"oneOf":[{"$ref":"#/components/schemas/journey_sign_withdrawal"},{"$ref":"#/components/schemas/journey_create_legal_entity_account"},{"$ref":"#/components/schemas/journey_sign_submission"},{"$ref":"#/components/schemas/journey_add_bank_account"},{"$ref":"#/components/schemas/journey_kyc_renewal"},{"$ref":"#/components/schemas/journey_update_allocation_plan"},{"$ref":"#/components/schemas/journey_update_savings_plan"},{"$ref":"#/components/schemas/create_account"}]},"callbackUrl":{"type":"string","description":"URL that receives a POST request when the journey status changes to canceled, error, or complete.\nThe payload includes the journey id, status, and scope.\nMust use https in production.\n","example":"https://api.habibisfonder.se/v1/fondo/callback"},"redirectUrl":{"type":["string","null"],"description":"Passed to BankID as the redirect target after mobile signing completes.\nSet this to a deep link (e.g. customerApp:///) so BankID returns the user to your app instead of the webview.\nNot needed for web-only integrations.\n","example":"customerApp:///"},"completionRedirectUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL the browser is redirected to once the journey completes successfully."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be an http(s) URL or a custom-scheme deep link (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"myapp://done"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for native-app handoff."},"children":[]}]}]}],"example":"https://partner.example/onboarding-done"},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."}}}},"components/schemas/journey_base":{"id":"components/schemas/journey_base","kind":"json-schema","title":"journey","data":{"$id":"/models/journey/journey_base.yaml","title":"journey","type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Journey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a web journey for interacting with Fondo functionality, such as setting up an account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback at the partner will be called with status of the journey, such as when it is completed or aborted due to end-user decision or error."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback information will also be sent over websocket if active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope parameter can be any value and used to keep state on partners end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback will be retried for any other status code than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure it is Fondo calling the callback URL, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to match."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fondo will also provide the IP address used from Fondos side."},"children":[]}]}]}],"required":["journey","callbackUrl","scope"],"properties":{"type":{"x-internal":true,"description":"Type of journey.\nMirrors the journey.journeyType\n","type":"string"},"status":{"readOnly":true,"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Journey created but not yet opened by the end customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — End customer has opened the journey and is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — End customer aborted the journey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — An error occurred during the journey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Journey completed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Journey URL expired before completion"},"children":[]}]}]}]}],"oneOf":[{"description":"New, journey not yet activated","type":"string","readOnly":true,"enum":["new"],"title":"new"},{"description":"Pending, journey in progress","type":"string","readOnly":true,"enum":["pending"],"title":"pending"},{"description":"Canceled, end-user aborted","type":"string","readOnly":true,"enum":["canceled"],"title":"canceled"},{"description":"Expired, TTL exceeded","type":"string","readOnly":true,"enum":["expired"],"title":"expired"},{"description":"Error, an error occured during the journey","type":"string","readOnly":true,"enum":["error"],"title":"error"},{"description":"Complete, journey is completed","type":"string","readOnly":true,"enum":["complete"],"title":"complete"}]},"id":{"description":"The ID of web journey.","allOf":[{"$ref":"#/components/schemas/uuid"},{"readOnly":true}]},"clientId":{"description":"The ID of requested client.","allOf":[{"$ref":"#/components/schemas/uuid"},{"readOnly":true}]},"url":{"readOnly":true,"type":"string","description":"journey url","example":"https://webbo.fondo.se/dT7KlfoMrjOspMBvyAq2bvD8cSSAVZg50bAh8G8U6z4nNPRHAy"},"expiryDate":{"readOnly":true,"type":"string","format":"date-time","description":"Date when journey token is considered stale","example":"2018-12-13T23:59:00.001Z"},"journey":{"type":"object","required":["journeyType"],"oneOf":[{"$ref":"#/components/schemas/journey_sign_withdrawal"},{"$ref":"#/components/schemas/journey_create_legal_entity_account"},{"$ref":"#/components/schemas/journey_sign_submission"},{"$ref":"#/components/schemas/journey_add_bank_account"},{"$ref":"#/components/schemas/journey_kyc_renewal"},{"$ref":"#/components/schemas/journey_update_allocation_plan"},{"$ref":"#/components/schemas/journey_update_savings_plan"},{"$ref":"#/components/schemas/create_account"}]},"sortedId":{"$ref":"#/components/schemas/ulid","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Date when acocunt was created","example":"2018-12-13T23:59:00.001Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z","readOnly":true},"deleted":{"description":"True if the journey is deleted","type":"boolean","readOnly":true},"deletedDate":{"readOnly":true,"type":["string","null"],"format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z"},"submission":{"description":"optional submission id.\nMay be created in legal entity journeys.\nMay be fetched on separate GET /submission/:id route\n","oneOf":[{"$ref":"#/components/schemas/uuid"},{"type":"null"}]},"callbackUrl":{"type":"string","description":"URL that receives a POST request when the journey status changes to canceled, error, or complete.\nThe payload includes the journey id, status, and scope.\nMust use https in production.\n","example":"https://api.habibisfonder.se/v1/fondo/callback"},"redirectUrl":{"type":["string","null"],"description":"Passed to BankID as the redirect target after mobile signing completes.\nSet this to a deep link (e.g. customerApp:///) so BankID returns the user to your app instead of the webview.\nNot needed for web-only integrations.\n","example":"customerApp:///"},"completionRedirectUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL the browser is redirected to once the journey completes successfully."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be an http(s) URL or a custom-scheme deep link (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"myapp://done"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for native-app handoff."},"children":[]}]}]}],"example":"https://partner.example/onboarding-done"},"errorCode":{"readOnly":true,"type":["string","null"],"description":"Any errors occurring during journey"},"context":{"type":["string","null"],"description":"Where end-user exited the journey. On error on cancel, if applicable.","example":"createaccountsign"},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."},"result":{"type":["object","null"],"description":"Result of journey","oneOf":[{"title":"createAccount result","properties":{"journeyType":{"type":"string","enum":["createAccount"]},"account":{"description":"account created in journey","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of account"},"status":{"$ref":"#/components/schemas/status"},"accountType":{"$ref":"#/components/schemas/accountType"},"serviceType":{"$ref":"#/components/schemas/serviceType"}}},"bankAccounts":{"description":"Payment accounts registered with allocation plan or savings plan","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of payment account"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandate status of the payment account"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Pending verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Active, ready for withdrawals"},"children":[]}]}]}]}],"type":"string","enum":["pending","rejected","active"]},"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}}},"transfers":{"description":"If transfers from other custodian was created, the results are provided here. One item per account.","type":"array","items":{"type":"object","properties":{"custodian":{"$ref":"#/components/schemas/uuid","description":"ID matching an institution."},"account":{"type":"string","description":"Account number at institution","example":"1223456789"}}}},"allocationPlan":{"description":"If an allocationPlan was created. The results are provided here\n","type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of allocation plan"},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of payment account"},"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}},"instruments":{"description":"Instrument allocations. The sum of all allocations must be exactly 100.","type":"array","example":[{"instrument":"SE0000810798SEK","allocation":100}],"items":{"$ref":"#/components/schemas/instrument_allocation_item"}}}},"savingsplan":{"description":"If a savings plan was created. The results are provided here\n","type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of savings plan"},"paymentAccountId":{"$ref":"#/components/schemas/uuid","description":"id of payment account used for autogiro"},"periodicity":{"type":"string","enum":["monthly"]},"day":{"type":"number","description":"Day of the month to allocate","minimum":1,"maximum":31},"instruments":{"description":"Instrument allocations with fixed amounts","type":"array","items":{"type":"object","properties":{"instrument":{"type":"string","description":"Instrument ID"},"amount":{"type":"number","description":"Amount in SEK","minimum":1}}}}}}}},{"title":"updateAllocationPlan result","properties":{"journeyType":{"type":"string","enum":["updateAllocationPlan"]},"allocationPlan":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/uuid","description":"Fondo account id"},"instruments":{"description":"Updated instrument allocations. The sum of all allocations must be exactly 100.","type":"array","items":{"$ref":"#/components/schemas/instrument_allocation_item"}},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of payment account"}}}}}}},{"title":"updateSavingsPlan result","properties":{"journeyType":{"type":"string","enum":["updateSavingsPlan"]},"savingsplan":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of savings plan"},"paymentAccountId":{"$ref":"#/components/schemas/uuid","description":"id of payment account used for autogiro"},"startDate":{"type":"string","format":"date-time","description":"Date when the savings plan starts"},"instruments":{"description":"Instrument allocations with fixed amounts","type":"array","items":{"type":"object","properties":{"instrument":{"type":"string","description":"Instrument ID"},"amount":{"type":"number","description":"Amount in SEK","minimum":1}}}}}}}},{"title":"signSubmission result","properties":{"journeyType":{"type":"string","enum":["signSubmission"]},"submission":{"type":"object","properties":{"submission":{"$ref":"#/components/schemas/uuid","description":"id of the signed submission"}}}}},{"title":"createLegalEntityAccount result","properties":{"journeyType":{"type":"string","enum":["createLegalEntityAccount"]},"submission":{"type":"object","properties":{"submission":{"$ref":"#/components/schemas/uuid","description":"id of the signed submission"}}}}},{"title":"kycRenewal result","additionalProperties":false,"properties":{"journeyType":{"type":"string","enum":["kycRenewal"]}}},{"title":"addBankAccount result","additionalProperties":false,"properties":{"journeyType":{"type":"string","enum":["addBankAccount"]}}}]}}}},"components/schemas/periodicity":{"id":"components/schemas/periodicity","kind":"json-schema","title":"Periodicity","data":{"$id":"/models/allocationplan/shared/periodicity.yaml","title":"Periodicity","description":"When to allocate","oneOf":[{"description":"Once per month allocation","type":"string","enum":["monthly"],"title":"monthly"},{"description":"Once per week allocation","type":"string","enum":["weekly"],"title":"weekly"},{"description":"allocate every bank day","type":"string","enum":["daily"],"title":"daily"},{"description":"direct","type":"string","enum":["direct"],"title":"direct"}]}},"components/schemas/instrument_allocation_item":{"id":"components/schemas/instrument_allocation_item","kind":"json-schema","title":"InstrumentAllocationItem","data":{"$id":"/models/allocationplan/shared/instrument_allocation_item.yaml","title":"InstrumentAllocationItem","type":"object","required":["instrument","allocation"],"properties":{"instrument":{"description":"Instrument ID","type":"string","example":"SE0000810798SEK"},"allocation":{"type":"number","example":100,"description":"Allocation in percent for this instrument"}}}},"components/schemas/deposit_type":{"id":"components/schemas/deposit_type","kind":"json-schema","title":"DepositType","data":{"$id":"/models/allocationplan/shared/deposit_type.yaml","title":"DepositType","description":"How to deposit cash to account","oneOf":[{"description":"Autogiro","type":"string","enum":["autogiro"],"title":"autogiro"},{"description":"Direct transfer via bank","type":"string","enum":["bank_transfer"],"title":"bank_transfer"},{"description":"Swish payment","type":"string","enum":["swish"],"title":"swish"}]}},"components/schemas/allocation_plan_patch":{"id":"components/schemas/allocation_plan_patch","kind":"json-schema","title":"UpdateAllocationPlan","data":{"$id":"/models/allocationplan/allocation_plan_patch.yaml","title":"UpdateAllocationPlan","type":"object","additionalProperties":false,"minProperties":1,"properties":{"bankAccount":{"allOf":[{"description":"ID of bank account with autogiro mandate","$ref":"#/components/schemas/uuid"}]}}}},"components/schemas/allocation_plans":{"id":"components/schemas/allocation_plans","kind":"json-schema","title":"AllocationPlans","data":{"$id":"/models/allocationplan/allocation_plans.yaml","title":"AllocationPlans","type":"array","items":{"$ref":"#/components/schemas/allocation_plan_base"}}},"components/schemas/allocation_plan_base":{"id":"components/schemas/allocation_plan_base","kind":"json-schema","title":"AllocationPlan","data":{"$id":"/models/allocationplan/allocation_plan_base.yaml","title":"AllocationPlan","type":"object","required":["id","account","instruments"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"ID of allocation plan"},"account":{"$ref":"#/components/schemas/uuid","description":"ID of account"},"bankAccount":{"$ref":"#/components/schemas/uuid","description":"ID of bank account"},"instruments":{"description":"Instrument allocations. The sum of all allocations must be exactly 100.","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/instrument_allocation_item"}}}}},"components/schemas/create_update_dates":{"id":"components/schemas/create_update_dates","kind":"json-schema","title":"create_update_dates","data":{"$id":"/models/common/create_update_dates.yaml","type":"object","properties":{"createdDate":{"type":"string","format":"date-time","description":"date when created","example":"2018-12-13T23:59:00.001Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z"}}}},"components/schemas/update_account_request":{"id":"components/schemas/update_account_request","kind":"json-schema","title":"update_account_request","data":{"$id":"/models/account/update_account_request.yaml","type":"object","required":["access","metadata","tags","name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of account"},"access":{"type":"string","description":"Accsess rights for owner","enum":["write","readDetails","readSummary"]},"tags":{"type":"array","items":{"type":"string"},"description":"JSON tags"},"metadata":{"type":"object","description":"JSON metadata"}}}},"components/schemas/create_account_request":{"id":"components/schemas/create_account_request","kind":"json-schema","title":"create_account_request","data":{"$id":"/models/account/create_account_request.yaml","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of account"}}}},"components/schemas/agreement":{"id":"components/schemas/agreement","kind":"json-schema","title":"agreement","data":{"$id":"/models/account/agreement.yaml","type":"object","required":["data"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"UUID of agreement"},"account":{"$ref":"#/components/schemas/uuid","description":"UUID of account"},"data":{"type":"object","description":"JSON data describing agreement","required":["signature"],"properties":{"signature":{"type":"string","description":"Base encoded string of signature"},"content":{"type":"string","description":"Base64 encoded signed content"}},"additionalProperties":true},"createdDate":{"type":"string","format":"date-time","description":"Date when acocunt was created","example":"2018-12-13T23:59:00.001Z"}}}},"components/schemas/custodians":{"id":"components/schemas/custodians","kind":"json-schema","title":"custodians","data":{"$id":"/models/custodian/custodians.yaml","type":"array","items":{"$ref":"#/components/schemas/custodian_base"}}},"components/schemas/custodian_base":{"id":"components/schemas/custodian_base","kind":"json-schema","title":"custodian_base","data":{"$id":"/models/custodian/custodian_base.yaml","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"UUID of custodian."},"name":{"type":"string","description":"Name of custodian"}}}},"components/schemas/patch_client":{"id":"components/schemas/patch_client","kind":"json-schema","title":"client","data":{"$id":"/models/client/patch_client.yaml","title":"client","type":"object","minProperties":1,"additionalProperties":false,"properties":{"displayName":{"type":"string","description":"Name of client as displayed in journeys","example":"Advise"},"name":{"type":"string","description":"Name of client","example":"Advise AB"},"bankAccounts":{"type":"array","description":"Bank account defintions based on fee type. No duplicate feeTypes allowed","uniqueItems":true,"items":{"$ref":"#/components/schemas/bank_account"}},"serviceTypes":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/service_type"}},"crn":{"$ref":"#/components/schemas/crn","description":"Company registration number. 10-digits."},"country":{"type":"string","description":"Two-letter country code","pattern":"^[A-Z][A-Z]$","example":"SE"}}}},"components/schemas/internal_service_type":{"id":"components/schemas/internal_service_type","kind":"json-schema","title":"serviceType","data":{"$id":"/models/client/internal_service_type.yaml","title":"serviceType","type":"object","description":"Supported Service Type","required":["accountServiceType","permissionGroup","agreementType"],"additionalProperties":false,"properties":{"accountServiceType":{"$ref":"#/components/schemas/serviceType"},"permissionGroup":{"type":"string","description":"Permissions group","example":"clientPortfolioManagement"},"agreementType":{"type":"string","description":"Type of agreement signed by end customer","example":"poa_trade"},"code":{"readOnly":true,"type":"string","description":"client activation code. 6 digits","example":"123456","pattern":"^[0-9]{6}$"}}}},"components/schemas/post_client":{"id":"components/schemas/post_client","kind":"json-schema","title":"client","data":{"$id":"/models/client/post_client.yaml","title":"client","type":"object","required":["name","displayName","crn","serviceTypes","country"],"additionalProperties":false,"properties":{"displayName":{"type":"string","description":"Name of client as displayed in journeys","example":"Advise"},"name":{"type":"string","description":"Name of client","example":"Advise AB"},"bankAccounts":{"type":"array","description":"Bank account defintions based on fee type. No duplicate feeTypes allowed","uniqueItems":true,"items":{"$ref":"#/components/schemas/bank_account"}},"serviceTypes":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/service_type"}},"crn":{"$ref":"#/components/schemas/crn","description":"Company registration number. 10-digits"},"country":{"type":"string","description":"Two-letter country code","pattern":"^[A-Z][A-Z]$","example":"SE"}}}},"components/schemas/signatory_groups":{"id":"components/schemas/signatory_groups","kind":"json-schema","title":"Signatory Groups","data":{"$id":"signatory_groups.yaml","type":"array","title":"Signatory Groups","description":"List of signatory groups.\nIf a group has only one person, that person may sign alone via a fondo journey.\nGroups with more than one person must have their signatures combined and collected via email.\n","additionalProperties":false,"items":{"type":"array","title":"Signatory Group","description":"Array of persons in this signatory group.","items":{"properties":{"name":{"type":"string","description":"Full name of the person"},"ssn":{"type":"string","description":"Social security number (decrypted)"}}}}}},"components/schemas/create_entity_account_application":{"id":"components/schemas/create_entity_account_application","kind":"json-schema","title":"Create Application Request","data":{"$id":"/models/application/create_entity_account_application.yaml","title":"Create Application Request","type":"object","required":["type"],"anyOf":[{"title":"create_account_legal_entity","type":"object","required":["accountOptions","type"],"properties":{"type":{"type":"string","enum":["create_account_legal_entity"]},"accountOptions":{"$ref":"#/components/schemas/legal_entity_account_options"}}}]}},"components/schemas/deposit_swish":{"id":"components/schemas/deposit_swish","kind":"json-schema","title":"deposit_swish","data":{"$id":"/models/swish/deposit_swish.yaml","type":"object","discriminator":{"propertyName":"type"},"oneOf":[{"title":"SwishDepositQr","type":"object","required":["type","amount","qrFormat"],"properties":{"type":{"type":"string","enum":["qr"],"description":"type of swish signature"},"clientRef":{"type":"string","description":"Client reference for tracking the payment"},"amount":{"type":"number","description":"Amount"},"qrFormat":{"type":"object","required":["format"],"description":"qr format in accordance to to swish Mcom to Qcom qr v1 https://developer.swish.nu/api/qr-codes/v1","properties":{"format":{"type":"string","enum":["jpg","svg","png"]},"size":{"type":"number","description":"Size of the QR code. The code is a square, so width and height are the same. Not required if the format is svg."},"border":{"type":"number","description":"Width of the border."},"transparent":{"type":"boolean","description":"Transparent background color. Does not work with jpg format."}}}}},{"title":"SwishDepositSameDevice","type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["same_device"],"description":"type of swish signature"},"clientRef":{"type":"string","description":"Client reference for tracking the payment"},"amount":{"type":"number","description":"Amount"}}}]}},"components/schemas/swish_callback":{"id":"components/schemas/swish_callback","kind":"json-schema","title":"swish_callback","data":{"$id":"/models/swish/swish_callback.yaml","x-internal":true,"type":"object","required":["payeePaymentReference","status","amount","currency"],"properties":{"payeePaymentReference":{"type":"string","description":"Reference to the payee payment"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the Swish payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DECLINED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ERROR"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED"},"children":[]}]}]}]}]},"paymentReference":{"type":"string","description":"Swish payment reference"},"amount":{"type":"number","description":"Payment amount"},"currency":{"type":"string","description":"Currency code"},"errorCode":{"type":["string","null"],"description":"Error code if payment failed"},"errorMessage":{"type":["string","null"],"description":"Error message if payment failed"}}}},"components/schemas/token_request":{"id":"components/schemas/token_request","kind":"json-schema","title":"Auth Token Request","data":{"$id":"/models/auth/token_request.yaml","title":"Auth Token Request","type":"object","required":["grant_type","client_id","client_secret"],"properties":{"grant_type":{"type":"string","enum":["client_credentials"]},"client_id":{"type":"string","description":"Your OAuth credential identifying your partner account, provided by Fondo during onboarding. Not related to the client concept in the API."},"client_secret":{"type":"string","description":"Your partner secret, provided by Fondo during onboarding. Keep this value confidential."},"scope":{"type":"string","description":"Comma separated list of scopes.\n","example":"`account:read, account:write`\n"},"state":{"type":"string","description":"Client state. For example a base64 encoded string of state data.\n","example":"VGhpcyBpcyBteSBzdGF0ZS4gVGhlcmUgYXJlIG1hbnkgbGlrZSBpdCwgYnV0IHRoaXMgaXMgb25lIG1pbmUu"}}}},"components/schemas/token_response":{"id":"components/schemas/token_response","kind":"json-schema","title":"Auth Token Request","data":{"$id":"/models/auth/token_response.yaml","title":"Auth Token Request","type":"object","required":["access_token","expires_in"],"properties":{"access_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access_token to use for subsequent requests"},"children":[]}]}]}],"example":"ffe74ba1-99a8-46e3-9ba2-9c0ef72e13c1"},"expires_in":{"type":"number","description":"The lifetime in seconds of the access token. Default is 432000 (5 days)","example":432000},"state":{"type":"string","description":"Client state. For example a base64 encoded string of state data.\n","example":"VGhpcyBpcyBteSBzdGF0ZS4gVGhlcmUgYXJlIG1hbnkgbGlrZSBpdCwgYnV0IHRoaXMgaXMgb25lIG1pbmUu"}}}},"components/schemas/uuid":{"id":"components/schemas/uuid","kind":"json-schema","title":"UUID","data":{"$id":"/models/uuid.yaml","title":"UUID","type":"string","example":"49ad7378-121c-4a53-9894-dfd14a7b4877","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"components/schemas/id":{"id":"components/schemas/id","kind":"json-schema","title":"UUID","data":{"$id":"/models/uuid.yaml","title":"UUID","type":"string","example":"49ad7378-121c-4a53-9894-dfd14a7b4877","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"components/schemas/eventId":{"id":"components/schemas/eventId","kind":"json-schema","title":"eventId","data":{"type":"string","format":"uuid","description":"Opaque UUID identifier unique per WebSocket message, deterministic across server instances. Use for deduplication when running overlapping connections during reconnect.\n"}},"components/schemas/ulid":{"id":"components/schemas/ulid","kind":"json-schema","title":"ULID","data":{"$id":"/models/ulid.yaml","title":"ULID","type":"string","description":"ULID (Universally Unique Lexicographically Sortable Identifier)","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV","pattern":"^[0-9a-zA-Z]{26}$","readOnly":true}},"components/schemas/natural_person":{"id":"components/schemas/natural_person","kind":"json-schema","title":"Natural Person","data":{"$id":"/models/account/natural_person.yaml","title":"Natural Person","type":"object","description":"Natural person account owner","additionalProperties":false,"required":["ownerType","firstName","lastName","fullName","ssn"],"properties":{"ownerType":{"type":"string","enum":["natural_person"],"title":"Natural Person"},"firstName":{"type":"string","description":"First name of account holder","example":"Ben"},"lastName":{"type":"string","description":"Last name of account holder","example":"Rangel"},"fullName":{"type":"string","description":"Full name of account holder","example":"Ben Rangel"},"ssn":{"$ref":"#/components/schemas/ssn","description":"Social security number of account holder"}}}},"components/schemas/legal_entity":{"id":"components/schemas/legal_entity","kind":"json-schema","title":"Legal Entity","data":{"$id":"/models/account/legal_entity.yaml","title":"Legal Entity","type":"object","description":"Legal entity account owner","additionalProperties":false,"required":["ownerType","name","crn"],"properties":{"ownerType":{"type":"string","enum":["legal_entity"],"title":"Legal Entity"},"name":{"type":"string","description":"Legal name of entity","example":"Acme Corp AB"},"crn":{"readOnly":true,"$ref":"#/components/schemas/crn","description":"Company registration number. 10-digits"},"type":{"type":"string","description":"Type of legal entity","example":"aktiebolag"},"registrationCountry":{"type":["string","null"],"description":"Country of registration (ISO 3166-1 alpha-2)","example":"SE"},"countriesOfTaxation":{"type":["array","null"],"description":"Countries where the entity is tax resident","items":{"type":"string","description":"Country code (ISO 3166-1 alpha-2)"},"example":["SE"]},"address":{"type":["object","null"],"description":"Registered address","properties":{"streetAddress":{"type":"string"},"zipCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"}}},"contactPerson":{"type":["object","null"],"description":"Primary contact person for the entity","properties":{"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"}}},"signatoryGroups":{"type":"array","description":"Signatory group combinations for the legal entity","items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of signatory"},"ssn":{"type":"string","description":"Social security number of signatory"},"email":{"type":["string","null"],"description":"Email of signatory"}}}}}}}},"components/schemas/account_owner":{"id":"components/schemas/account_owner","kind":"json-schema","title":"Account Owner","data":{"$id":"/models/account/account_owner.yaml","title":"Account Owner","discriminator":{"propertyName":"ownerType"},"oneOf":[{"$ref":"#/components/schemas/natural_person"},{"$ref":"#/components/schemas/legal_entity"}]}},"components/schemas/payment_account":{"id":"components/schemas/payment_account","kind":"json-schema","title":"paymentAccount","data":{"$id":"/models/payment/payment_account.yaml","title":"paymentAccount","type":"object","required":["iban","name","bank"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/id"},"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"},"bban":{"type":"string","description":"Local bank account number","example":"666 666 666"},"bank":{"type":"string","description":"Bank name","example":"Buy n' Large"},"name":{"type":["string","null"],"description":"Name of account","example":"Lönekonto"},"createdDate":{"type":"string","format":"date-time","description":"Date when acocunt was created","example":"2018-12-13T23:59:00.001Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z"},"deletedDate":{"type":"string","format":"date-time","description":"Date when and if deleted","example":"2018-12-13T23:59:00.001Z"},"validated":{"type":"boolean","description":"Whether the bank account is validated by account check service.\nRequired for withdrawals\n","example":true},"mandateStatus":{"type":"string","description":"Status of the autogiro mandate for this account","enum":["missing","invalid","pending","active"],"example":"active"}}}},"components/schemas/fee_types":{"id":"components/schemas/fee_types","kind":"json-schema","title":"feeType","data":{"$id":"/models/transaction/fee_types.yaml","title":"feeType","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_oneoff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — One-off fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_ongoing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Ongoing fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transactional fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_performance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Performance fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Other fee"},"children":[]}]}]}]}],"enum":["client_fee_oneoff","client_fee_ongoing","client_fee_transaction","client_fee_performance","client_fee_other"]}},"components/schemas/bank_account":{"id":"components/schemas/bank_account","kind":"json-schema","title":"bankAccount","data":{"$id":"/models/client/bank_account.yaml","title":"bankAccount","type":"object","description":"Bank account definition based on fee type","required":["feeType","iban"],"additionalProperties":false,"properties":{"feeType":{"$ref":"#/components/schemas/fee_types"},"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}}},"components/schemas/serviceType":{"id":"components/schemas/serviceType","kind":"json-schema","title":"Account service type","data":{"title":"Account service type","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolioManagement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Portfolio management"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"investmentAdvise"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Investment advice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executionOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Execution only"},"children":[]}]}]}]}],"enum":["portfolioManagement","investmentAdvise","executionOnly"]}},"components/schemas/service_type":{"id":"components/schemas/service_type","kind":"json-schema","title":"serviceType","data":{"$id":"/models/client/service_type.yaml","title":"serviceType","type":"object","description":"Supported Service Type","required":["accountServiceType"],"additionalProperties":false,"properties":{"accountServiceType":{"$ref":"#/components/schemas/serviceType"},"code":{"readOnly":true,"type":"string","description":"client activation code. 6 digits","example":"123456","pattern":"^[0-9]{6}$"}}}},"components/schemas/client_base":{"id":"components/schemas/client_base","kind":"json-schema","title":"client","data":{"$id":"/models/client/client_base.yaml","title":"client","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/id"},"sortedId":{"$ref":"#/components/schemas/ulid"},"displayName":{"type":"string","description":"Name of client as displayed in journeys","example":"Advise"},"name":{"type":"string","description":"Name of client","example":"Advise AB"},"bankAccounts":{"type":"array","description":"Bank account defintions based on fee type. No duplicate feeTypes allowed","uniqueItems":true,"items":{"$ref":"#/components/schemas/bank_account"}},"serviceTypes":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/service_type"}},"crn":{"$ref":"#/components/schemas/crn","description":"Company registration number"},"country":{"type":"string","description":"Two-letter country code","pattern":"^[A-Z][A-Z]$","example":"SE"},"permissions":{"type":"object","description":"Client permissions and capabilities","readOnly":true,"additionalProperties":false,"properties":{"allowAutogiro":{"type":"boolean","description":"Whether autogiro deposits are allowed for this client"},"allowSwishDeposits":{"type":"boolean","description":"Whether Swish deposits are allowed for this client"},"allowLegalEntity":{"type":"boolean","description":"Whether legal entity accounts are allowed for this client"},"allowEnrichedInstrument":{"type":"boolean","description":"Whether enriched instrument data is returned for this client"},"allowHistoricalFundPrice":{"type":"boolean","description":"Whether historical fund price data is available"},"allowedAccountCategories":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MiFID II investor classifications allowed for this client."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pro"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Professional investor (MiFID II)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Retail investor, protected by consumer protection regulations (MiFID II)"},"children":[]}]}]}]}],"items":{"type":"string","enum":["pro","retail"]}}}}}}},"components/schemas/executor_ref":{"id":"components/schemas/executor_ref","kind":"json-schema","title":"executor reference","data":{"$id":"/models/common/executor_ref.yaml","type":"string","title":"executor reference","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSN of the individual executing the operation. On write operations, validated against the account owner's SSN — requests with a mismatched value are rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The partner is responsible for verifying the executor's identity (e.g. via BankID) before including this value."},"children":[]}]}]}],"example":"197001010003"}},"components/schemas/client_ref":{"id":"components/schemas/client_ref","kind":"json-schema","title":"client reference","data":{"$id":"/models/common/client_ref.yaml","type":"string","title":"client reference","description":"Client applied ref","example":"my_order_123"}},"components/schemas/cash_transaction":{"id":"components/schemas/cash_transaction","kind":"json-schema","title":"cashTransaction","data":{"$id":"/models/transaction/cash_transaction.yaml","type":"object","title":"cashTransaction","description":"Cash Transaction","required":["transactionType","amount","currency","revision","aborted","sortedId","id"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/id"},"sortedId":{"$ref":"#/components/schemas/ulid"},"transactionType":{"title":"Cash transaction type","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash transaction type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deposit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Deposit of cash to account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fxFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — FX fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"withdrawal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Withdrawal of cash from account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfer of cash to account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfer of cash from account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Subscription order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redemption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Redemption order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retrocession"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Retrocession cash amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insurance_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Tax for the insurance"},"children":[]}]}]}]}],"enum":["deposit","fxFee","withdrawal","transfer_in","transfer_out","subscription","redemption","retrocession","insurance_tax"]},"aborted":{"description":"Transaction has been aborted.","type":"boolean","default":false},"abortedReason":{"type":"string","description":"Error code or freetext explaining abort","example":"referenced_order_canceled"},"revision":{"$ref":"#/components/schemas/ulid"},"abortedDate":{"type":"string","format":"date-time","description":"Date when transaction was aborted","example":"2018-12-13T23:59:00.001Z","readOnly":true},"correctedBy":{"description":"If this value is set, the transaction has been corrected by the transaction referenced by the id.\nAny calculations must ignore transactions where correctedBy is set.\n","$ref":"#/components/schemas/id"},"correctedReason":{"type":"string","description":"Reason for the correction","example":"order_amount_adjusted"},"ref":{"type":"string","description":"Transaction reference. External id. 255 chars.","maxLength":255},"refType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of reference:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Text reference"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Reference is an ID of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Reference is an ID of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ca"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Reference is an ID of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ca"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (corporate action) object"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transaction between internal accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transaction between external accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Reference is an ID of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_oneoff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — One-off fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_ongoing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Ongoing fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transactional fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_performance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Performance fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee_other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Other fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Unspecified client fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"correction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Correction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Gift"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compensations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Compensations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inheritance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Inheritance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dividend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Dividend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"donation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Donation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endowment_101"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Endowment 101"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Partner Fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fondo_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fondo Fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insurance_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Insurance Tax"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insurance_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Insurance Fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"riskpremia_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Riskpremia Fee"},"children":[]}]}]}]}],"enum":["text","order","payment","ca","internal","external","transfer","client_fee_oneoff","client_fee_ongoing","client_fee_transaction","client_fee_performance","client_fee_other","client_fee","correction","gift","compensations","inheritance","dividend","donation","endowment_101","partner_fee","fondo_fee","insurance_tax","insurance_fee","riskpremia_fee"]},"creditAccount":{"$ref":"#/components/schemas/uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID of credited (receiving) account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for transaction types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deposit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfer_in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redemption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrocession"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refundCancel"},"children":[]}]}]}]}]},"debitAccount":{"$ref":"#/components/schemas/uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID of debited (charged) account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for transaction types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"withdrawal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfer_out"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fxFee"},"children":[]}]}]}]}]},"amount":{"type":"number","description":"Transaction amount as a number","example":1.2},"currency":{"type":"string","description":"Three letter ISO currency code","pattern":"^[A-Z]{3}$","example":"SEK","enum":["SEK"],"default":"SEK"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"clientRef":{"$ref":"#/components/schemas/client_ref"},"freetext":{"type":"string","description":"Free text of transaction","example":"Hello world"},"instrument":{"type":"string","description":"Id of instrument if it is a transaction related to a specific instrument but not an order, ie retrocession","example":"SE0012193019SEK"},"startDate":{"type":"string","format":"date","description":"If a transaction is regarding a period of time\nUsed for retrocession transactionType\n"},"endDate":{"type":"string","format":"date","description":"If a transaction is regarding a period of time.\nUsed for retrocession transaction type.\n"},"createdDate":{"type":"string","format":"date-time","description":"Date when transaction was created","example":"2018-12-13t23:59:00.001z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13t23:59:00.001z","readOnly":true},"settlementDate":{"type":["string","null"],"format":"date-time","description":"Date when transaction was settled, null if not settled","example":"2018-12-13t23:59:00.001z","readOnly":true}}}},"components/schemas/fund_transaction":{"id":"components/schemas/fund_transaction","kind":"json-schema","title":"fundTransaction","data":{"$id":"/models/transaction/fund_transaction.yaml","type":"object","title":"fundTransaction","description":"An object representing a fund transaction","required":["transactionType","currency","account","units","identifier","instrument","id","sortedId","revision"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/id"},"sortedId":{"$ref":"#/components/schemas/ulid"},"transactionType":{"title":"Fund transaction type","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redemption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Units of a redemption order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Units of a subscription order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Units transferred to account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_out"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Units transferred out of account"},"children":[]}]}]}]}],"enum":["redemption","subscription","transfer_in","transfer_out"]},"aborted":{"description":"Transaction has been aborted.","type":"boolean","default":false},"abortedReason":{"type":"string","description":"Error code or freetext explaining abort","example":"referenced_order_canceled"},"correctedBy":{"description":"If this value is set, the transaction has been corrected by the transaction referenced by the id.\nAny calculations must ignore transactions where correctedBy is set.\n","$ref":"#/components/schemas/id"},"revision":{"$ref":"#/components/schemas/ulid"},"abortedDate":{"type":"string","format":"date-time","description":"Date when transaction was aborted","example":"2018-12-13T23:59:00.001Z","readOnly":true},"correctedReason":{"type":"string","description":"Reason for the correction","example":"order_amount_adjusted"},"ref":{"type":"string","description":"Reference ID of the object that caused the transaction (order, ca etc)"},"refType":{"type":"string","description":"Type that caused the transaction","enum":["order","ca","internal","external","transfer","gift","compensations","inheritance","dividend","endowment_101","text","correction"]},"account":{"$ref":"#/components/schemas/uuid","description":"UUID of account of transaction"},"instrument":{"type":"string","description":"Fondo instrument ID","example":"SE0012193019SEK"},"identifier":{"description":"ISIN code of fund instrument","type":"string","example":"SE0012193019"},"units":{"type":"number","description":"Transaction fund units"},"price":{"type":"number","description":"Transaction price per unit (NAV)"},"currency":{"type":"string","description":"Three letter ISO currency code of transaction","pattern":"^[A-Z]{3}$","example":"SEK"},"freetext":{"type":"string","description":"Free text of transaction","example":"Hello world"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"clientRef":{"$ref":"#/components/schemas/client_ref"},"createdDate":{"type":"string","format":"date-time","description":"date when created","example":"2018-12-13T23:59:00.001Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z","readOnly":true},"settlementDate":{"type":"string","format":"date-time","description":"Date when transaction was settled, null if not settled","example":"2018-12-13T23:59:00.001Z","readOnly":true},"tradeDate":{"type":"string","format":"date-time","description":"Trade date (date of pricing)","example":"2018-12-13T23:59:00.001Z","readOnly":true}}}},"components/schemas/order_base":{"id":"components/schemas/order_base","kind":"json-schema","title":"order","data":{"$id":"/models/order/order_base.yaml","type":"object","title":"order","description":"order","required":["account","instrument","orderType"],"allOf":[{"properties":{"sortedId":{"$ref":"#/components/schemas/ulid"},"orderType":{"enum":["subscription","redemption"]},"account":{"$ref":"#/components/schemas/uuid","description":"Account number"},"clientRef":{"oneOf":[{"$ref":"#/components/schemas/client_ref"},{"type":"null"}]},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"instrument":{"type":"string","example":"US64110L1061USD","description":"Fondo instrument ID"},"units":{"type":"number","example":1000,"description":"Number of units. 7 decimals. Required for redemption orders."},"amount":{"type":"number","example":100,"description":"Required for subscription orders. For a redemption order this will be calculated on confirmation.\n"},"clientId":{"$ref":"#/components/schemas/uuid","description":"ID of the client"}}},{"if":{"properties":{"orderType":{"oneOf":[{"const":"subscription"}]}}},"then":{"required":["amount"]}},{"if":{"properties":{"orderType":{"oneOf":[{"const":"redemption"}]}}},"then":{"required":["units"]}}]}},"components/schemas/journey_sign_withdrawal":{"id":"components/schemas/journey_sign_withdrawal","kind":"json-schema","title":"signWithdrawal","data":{"$id":"/models/journey/journey_sign_withdrawal.yaml","title":"signWithdrawal","required":["payment"],"additionalProperties":false,"description":"Let end user sign an insurance withdrawal request.\n","properties":{"payment":{"$ref":"#/components/schemas/uuid","description":"Fondo paymentId. (usually located on cashTransaction.ref for withdrawals)\n"},"journeyType":{"type":"string","title":"signWithdrawal","enum":["signWithdrawal"]}}}},"components/schemas/legal_entity_account_types":{"id":"components/schemas/legal_entity_account_types","kind":"json-schema","title":"Legal Entity Account Types","data":{"$id":"/models/shared/legal_entity_account_types.yaml","title":"Legal Entity Account Types","type":"array","description":"insurance - Endowment Insurance\ndepot - Depot\n","minItems":1,"items":{"type":"string","enum":["insurance","depot"]}}},"components/schemas/journey_update_savings_plan":{"id":"components/schemas/journey_update_savings_plan","kind":"json-schema","title":"updateSavingsPlan","data":{"$id":"/models/journey/journey_update_savings_plan.yaml","title":"updateSavingsPlan","required":["account","journeyType"],"additionalProperties":false,"description":"Let end user create, update, or cancel a savings plan for an account.\n","properties":{"journeyType":{"type":"string","title":"updateSavingsPlan","enum":["updateSavingsPlan"]},"account":{"$ref":"#/components/schemas/uuid","description":"Fondo account"},"instruments":{"description":"Instruments available for the savings plan.\nIf omitted, the end user may choose from all instruments in the client universe.\n","type":"array","items":{"type":"object","required":["instrument"],"additionalProperties":false,"properties":{"instrument":{"type":"string","description":"Instrument ID"}}}}}}},"components/schemas/transfer-2":{"id":"components/schemas/transfer-2","kind":"json-schema","title":"Transfer","data":{"title":"Transfer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer configuration from 3rd party institution into newly created Fondo Account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If defined, the transfer screen is shown."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the transfer view will not be shown."},"children":[]}]}]}],"type":["object","null"],"required":["enforce","transfers"],"properties":{"enforce":{"type":"string","enum":["required","optional"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls whether the end user can skip the transfer step."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the end user must complete the transfer step."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the end user may skip the transfer step."},"children":[]}]}]}]},"transfers":{"description":"List of custodians and their accounts to transfer from.\nThe custodian is always readonly. Account numbers, when provided, are readonly.\n","type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["custodian","accounts"],"properties":{"custodian":{"$ref":"#/components/schemas/uuid","description":"ID matching a custodian."},"accounts":{"type":"array","description":"Accounts at this custodian. Each account is either known (accountNumber set)\nor unknown (accountNumber null, end user enters it).\n","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["accountNumber","required","defaultUnitsOutput","balanceOutput","closeAccountAndSavingsplans","sourceAccountType","untransferableUnitsOutput","allowInstrumentSelection"],"if":{"properties":{"accountNumber":{"type":"string"}}},"then":{"properties":{"sourceAccountType":{"maxItems":1}}},"properties":{"accountNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number at the custodian. Readonly when provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the end user enters the account number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At most one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" account number is allowed per custodian across all transfer entries."},"children":[]}]}]}],"example":"1223456789"},"sourceAccountType":{"type":"array","minItems":1,"items":{"type":"string","enum":["isk","depot","insurance"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed source account types at the custodian."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single entry locks the type; multiple entries let the end user pick."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each entry must be one of the journey's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locked to one entry when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},"closeAccountAndSavingsplans":{"type":["boolean","null"],"description":"Should the custodian close the account and corresponding savingsplans\nafter the transfer is complete?\nIf \"null\", the user must decide.\n"},"required":{"type":"boolean","description":"If true, the end user must complete this transfer.\nIf false, the end user may deselect this transfer.\n"},"untransferableUnitsOutput":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If units are selected as output of unit transfer - what to transfer as if the transfer fails."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"I.e. the instrument does not exist in universe or trading is stopped."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a single entry, the behavior is locked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple entries, the end user picks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cash"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sell and transfer as cash."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ignore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — leave them."},"children":[]}]}]}],"type":"array","minItems":1,"items":{"type":"string","enum":["cash","ignore"]}},"defaultUnitsOutput":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What to do with instruments not listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instruments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a single entry, the behavior is locked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple entries, the end user picks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cash"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sell and transfer as cash."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"units"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — transfer as units."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ignore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — leave them."},"children":[]}]}]}],"minItems":1,"items":{"type":"string","enum":["cash","units","ignore"]}},"balanceOutput":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What to do with the account's cash balance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a single entry, the behavior is locked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple entries, the end user picks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cash"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — transfer the cash balance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ignore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — leave it."},"children":[]}]}]}],"minItems":1,"items":{"type":"string","enum":["cash","ignore"]}},"allowInstrumentSelection":{"type":"boolean","description":"Should the end user be able to add specific instruments to transfer?\n"},"instruments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific instruments to transfer from this account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If omitted, all instruments are handled by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defaultUnitsOutput"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"required":["id","unitType","outputType"],"if":{"properties":{"unitType":{"not":{"contains":{"const":"partial"}}}}},"then":{"properties":{"units":{"type":"null"}}},"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instrument ID (ISIN + currency)."},"children":[]}]}]}],"example":"SE0000810798SEK"},"unitType":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a single entry, the behavior is locked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple entries, the end user picks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — all units of this instrument."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a specific number of units."},"children":[]}]}]}],"minItems":1,"items":{"type":"string","enum":["full","partial"]}},"outputType":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a single entry, the behavior is locked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple entries, the end user picks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cash"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sell and transfer as cash."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"units"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — transfer as units."},"children":[]}]}]}],"minItems":1,"items":{"type":"string","enum":["cash","units"]}},"units":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of units to transfer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If omitted, the end user enters the amount."},"children":[]}]}]}]}}}}}}}}}}}}},"components/schemas/create_account":{"id":"components/schemas/create_account","kind":"json-schema","title":"createAccount","data":{"$id":"/models/journey/createAccount/create_account.yaml","title":"createAccount","required":["accountTypes","accountServiceType","journeyType"],"additionalProperties":false,"not":{"allOf":[{"required":["allocationPlan"],"properties":{"allocationPlan":{"type":"object"}}},{"required":["savingsPlan"],"properties":{"savingsPlan":{"type":"object"}}}]},"properties":{"journeyType":{"type":"string","title":"createAccount","enum":["createAccount"]},"welcomeScreen":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional custom welcome screen."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently only available when transfer is set."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only allowed in combination with populated transfer field"},"children":[]}]}]}]}],"type":"string","enum":["transfer"]},"email":{"type":["string","null"],"format":"email","description":"end user email address","example":"enduser@endUserDomain.com"},"accountName":{"type":"string","maxLength":500,"description":"If not provided, the end-user will be asked to select accountName. If provided, the accountName will not be visible to the customer in this journey."},"accountTypes":{"type":"array","description":"Allowed account types","items":{"enum":["isk","depot","insurance"]}},"accountServiceType":{"description":"Account service type","type":"string","title":"accountServiceType","enum":["portfolioManagement","investmentAdvise","executionOnly"]},"accountCategories":{"$ref":"#/components/schemas/optional_account_categories"},"allocationPlan":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setup an allocation plan for the account. Deposits will allocate based on this plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the view will not be shown"},"children":[]}]}]}],"type":["object","null"],"required":["instruments"],"properties":{"depositType":{"$ref":"#/components/schemas/deposit_type"},"periodicity":{"$ref":"#/components/schemas/periodicity"},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","properties":{"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}},"instruments":{"description":"Instrument allocations. The sum of all allocations must be exactly 100.","type":"array","example":[{"instrument":"SE0000810798SEK","allocation":100}],"items":{"$ref":"#/components/schemas/instrument_allocation_item"}}}},"savingsPlan":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable savings plan setup during account creation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User will configure instruments and amounts in the UI."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the view will not be shown."},"children":[]}]}]}],"type":["object","null"],"required":["periodicity"],"properties":{"periodicity":{"type":"string","enum":["monthly"]},"instruments":{"description":"Instruments available for the savings plan.\nIf omitted, the end user may choose from all instruments in the client universe.\n","type":"array","items":{"type":"object","required":["instrument"],"additionalProperties":false,"properties":{"instrument":{"type":"string","description":"Instrument ID"}}}}}},"kycs":{"description":"Valid Know Your Customer answers used to prefill the options in the journey.","type":["array","null"],"items":{"type":"object","required":["qid","answer"],"properties":{"qid":{"description":"Fondo ID of the question","example":"money_origin","type":"string"},"answer":{"description":"Answer","example":"lön/pension","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array"},{"type":"object"}]}}}},"transfer":{"$ref":"#/components/schemas/transfer-2"}}}},"components/schemas/status":{"id":"components/schemas/status","kind":"json-schema","title":"Account status","data":{"title":"Account status","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Account created, waiting for approval"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Account is open and operational"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Account application was rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Account is awaiting confirmation from the end customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Account is being closed; new orders, payments and withdrawals are not accepted"},"children":[]}]}]}]}],"enum":["pending","active","rejected","confirm","closing"]}},"components/schemas/accountType":{"id":"components/schemas/accountType","kind":"json-schema","title":"Account type","data":{"title":"Account type","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — ISK, investeringssparkonto"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Depot, fonddepå"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insurance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Endowment insurance, kapitalförsäkring. Requires the user to sign separately with the insurance provider."},"children":[]}]}]}]}],"enum":["isk","depot","insurance"]}},"components/schemas/performance_entry":{"id":"components/schemas/performance_entry","kind":"json-schema","title":"performance_entry","data":{"$id":"/models/performance/performance_entry.yaml","type":"object","required":["date","dayReturn","dayResult","cumulativeReturn"],"properties":{"date":{"type":"string","format":"date","description":"The date of the performance entry.","example":"2025-01-02"},"dayReturn":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The daily return as a decimal (e.g. 0.0032 = 0.32%)."},"children":[]}]}]}],"example":0.0032},"dayResult":{"type":"number","description":"The absolute SEK profit/loss for the day\n","example":120.12},"cumulativeReturn":{"type":"number","example":-0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cumulative return since account inception as a fraction (e.g. 0.05 means +5%)"},"children":[]}]}]}]}}}},"components/schemas/account_value":{"id":"components/schemas/account_value","kind":"json-schema","title":"account_value","data":{"$id":"/models/performance/account_value.yaml","type":"object","required":["marketValue"],"properties":{"marketValue":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total market value of the account — the sum of settled cash balance, settled position value, and pending subscription amounts."},"children":[]}]}]}],"example":215000}}}},"components/schemas/withdrawal_request":{"id":"components/schemas/withdrawal_request","kind":"json-schema","title":"withdrawal","data":{"$id":"/models/transaction/withdrawal_request.yaml","type":"object","title":"withdrawal","description":"Withdrawal","required":["amount","executorRef","withdrawalType"],"properties":{"clientRef":{"$ref":"#/components/schemas/client_ref"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"amount":{"type":"number","description":"Transaction amount"}},"oneOf":[{"type":"object","title":"bank_payout","description":"Payout to customers bank account","required":["bankAccount"],"properties":{"withdrawalType":{"type":"string","const":"bank_payout","title":"bank_payout","description":"Payout to customers bank account"},"bankAccount":{"$ref":"#/components/schemas/uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of bank account from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema"},"children":[]}]}]}]}}},{"type":"object","title":"fee_charge","description":"Charge of fee to customers account","required":["feeType"],"properties":{"withdrawalType":{"type":"string","const":"fee_charge","title":"fee_charge","description":"Charge of fee to customers account"},"feeType":{"$ref":"#/components/schemas/fee_types"}}}]}},"components/schemas/agreement_type":{"id":"components/schemas/agreement_type","kind":"json-schema","title":"agreementType","data":{"$id":"/models/agreement/agreement_type.yaml","title":"agreementType","type":"object","required":["key","swe","createdDate"],"properties":{"key":{"type":"string","description":"Agreement type identifier","example":"account"},"swe":{"type":"string","description":"Swedish name for the agreement type","example":"Kontoavtal"},"createdDate":{"type":"string","format":"date-time","description":"Date when the agreement was created","example":"2024-03-15T12:00:00.000Z"}}}},"components/schemas/swish_poll_response":{"id":"components/schemas/swish_poll_response","kind":"json-schema","title":"swish_poll_response","data":{"$id":"/models/swish/swish_poll_response.yaml","type":"object","properties":{"status":{"type":"string","description":"status from Swish","example":"PAID"},"errorCode":{"type":["string","null"],"description":"error code from Swish","example":"AM02"}}}},"components/schemas/swish_deposit_response":{"id":"components/schemas/swish_deposit_response","kind":"json-schema","title":"swish_deposit_response","data":{"$id":"/models/swish/swish_deposit_response.yaml","type":"object","properties":{"id":{"type":"string","description":"id of Swish payment. Use to get status of signature"},"token":{"type":"string","description":"Swish token. Used to start bankid app on same devie"},"qrImage":{"type":"string","description":"Swish qr image. Provided only if type set to qr"},"paymentId":{"description":"id of corresponding payment object","$ref":"#/components/schemas/uuid","readOnly":true}}}},"components/schemas/redemption_transfer":{"id":"components/schemas/redemption_transfer","kind":"json-schema","title":"redemptionTransfer","data":{"$id":"/models/order/order_redemption_transfer.yaml","type":"object","description":"redemption order with cash transfer to another internal account","title":"redemptionTransfer","required":["account","instrument","units","executorRef","targetAccount"],"properties":{"account":{"$ref":"#/components/schemas/uuid","description":"Source account ID"},"clientRef":{"type":"string","description":"Client applied ref","example":"my_order_123"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"instrument":{"type":"string","example":"US64110L1061USD","description":"Fondo instrument ID"},"units":{"type":"number","example":1000,"description":"Number of units. 7 decimals"},"targetAccount":{"$ref":"#/components/schemas/uuid","description":"Target Fondo account ID to receive the redemption proceeds. Must\nbelong to the same client and owner as the source account, and have the\nsame accountType. Insurance accounts are not supported. The redeemed\namount settles on the source account first and is then transferred to\nthe target account.\n"}}}},"components/schemas/withdrawal_limit":{"id":"components/schemas/withdrawal_limit","kind":"json-schema","title":"withdrawalLimit","data":{"$id":"/models/withdrawal/withdrawal_limit.yaml","type":"object","title":"withdrawalLimit","description":"Withdrawal limit for an account","required":["min","max"],"additionalProperties":false,"properties":{"min":{"type":"number","description":"Minimum withdrawal amount"},"max":{"type":"number","description":"Maximum withdrawal amount"}}}},"components/schemas/order_subscription":{"id":"components/schemas/order_subscription","kind":"json-schema","title":"subscription order","data":{"$id":"/models/order/order_subscription.yaml","type":"object","description":"subscription order","title":"subscription order","required":["account","instrument","orderType","amount","executorRef"],"properties":{"orderType":{"const":"subscription"},"account":{"$ref":"#/components/schemas/uuid","description":"Account ID"},"clientRef":{"type":"string","description":"Client applied ref","example":"my_order_123"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"instrument":{"type":"string","example":"US64110L1061USD","description":"Fondo instrument ID"},"amount":{"type":"number","example":100,"description":"The amount to subscribe for.\n"}}}},"components/schemas/order_redemption":{"id":"components/schemas/order_redemption","kind":"json-schema","title":"redemption order","data":{"$id":"/models/order/order_redemption.yaml","type":"object","description":"redemption order","title":"redemption order","required":["account","instrument","orderType","units","executorRef"],"properties":{"orderType":{"const":"redemption"},"account":{"$ref":"#/components/schemas/uuid","description":"Account ID"},"clientRef":{"type":"string","description":"Client applied ref","example":"my_order_123"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"instrument":{"type":"string","example":"US64110L1061USD","description":"Fondo instrument ID"},"units":{"type":"number","example":1000,"description":"Number of units. 7 decimals"}}}},"components/schemas/order_request":{"id":"components/schemas/order_request","kind":"json-schema","title":"order_request","data":{"$id":"/models/order/order_request.yaml","discriminator":{"propertyName":"orderType"},"oneOf":[{"$ref":"#/components/schemas/order_subscription"},{"$ref":"#/components/schemas/order_redemption"}]}},"components/schemas/instrument_id":{"id":"components/schemas/instrument_id","kind":"json-schema","title":"instrumentId","data":{"$id":"/models/instrument/instrument_id.yaml","title":"instrumentId","type":"string","description":"Fondo instrument ID\n","example":"SE0012193019SEK","pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9][A-Z]{3}$"}},"components/schemas/fund":{"id":"components/schemas/fund","kind":"json-schema","title":"fund","data":{"$id":"/models/instrument/fund.yaml","type":"object","properties":{"id":{"$ref":"#/components/schemas/instrument_id"},"isincode":{"type":"string","example":"SE0001862426"},"name":{"type":"string","example":"Adrigo Hedge","description":"Name of fund"},"currency":{"type":"string","pattern":"^[a-zA-Z]{3}$","description":"Currency code of fund","example":"NOK"},"closePrice":{"type":"number","description":"Last closing price"},"priceDate":{"type":"string","format":"date-time","description":"Date when price was updated","example":"2018-12-13T23:59:00.001Z"},"kiid":{"type":["array","null"],"items":{"type":"object","properties":{"href":{"type":"string","description":"HTTP URL link to document","example":"https://doc.morningstar.com/document/dE423E4e4d2D4ED4d4e.msdoc/?clientId=fondo&key=key"},"format":{"type":"string","description":"File format of doucment.","example":"PDF"},"id":{"type":["string","null"]}}}},"decimalsUnits":{"type":["number","null"],"description":"Number of decimals used for fund units"},"minInvestmentAmountSEK":{"type":["number","null"],"description":"Minimum amount for subscription orders.\nSynonymous with minInitialAmountSek\n","deprecated":true},"minInitialAmountSek":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum amount for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscription order on the account."},"children":[]}]}]}]},"minSubsequentAmountSek":{"type":["number","null"],"description":"Minimum amount for subscription orders placed\nwhen an account already holds a position.\n"},"isComplex":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the instrument is deemed "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complex"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", retail clients must complete additional appropriateness checks before investing."},"children":[]}]}]}]},"isBuyable":{"type":"boolean","description":"Is fund buyable"},"isSellable":{"type":"boolean","description":"Is fund sellable"},"isTradable":{"type":"boolean","description":"Is fund tradeable, i.e. either buyable or sellable"},"cost":{"type":"object","properties":{"total":{"type":"number"},"fx":{"type":"number"},"transactionFeeActual":{"type":["number","null"]},"ongoingActual":{"type":["number","null"]},"managementFee":{"type":["number","null"]},"managementFeeActual":{"type":["number","null"]},"performanceFeeActual":{"type":["number","null"]},"transactionFeeEstimated":{"type":["number","null"]},"ongoingEstimated":{"type":["number","null"]},"managementFeeEstimated":{"type":["number","null"]},"performanceFeeEstimated":{"type":["number","null"]}}},"rebate":{"type":"number","description":"The rebate for this fund in bips","example":96},"isRaif":{"type":"boolean","description":"Is this a Reserved Alternative Investment Fund (RAIF)"},"cutOffTime":{"type":"string","description":"Ordinary cut-off time of day for placing same day orders","example":"11:00:00"},"subscriptionSettlementDays":{"type":"number","description":"Number of days for subscription settlement"},"redemptionSettlementDays":{"type":"number","description":"Number of days for redemption settlement"},"cutOffDateSub":{"type":["string","null"],"format":"date","description":"Deadline date to place a subscription order for the next trading batch,\ncomputed from the trading calendar. For daily-traded funds this is the next\nbank day whose cut-off time has not yet passed; for scheduled funds it is\ncomputed against the fund's trading cycle. Null when it cannot be computed.\n"},"cutOffDateRed":{"type":["string","null"],"format":"date","description":"Deadline date to place a redemption order for the next trading batch,\ncomputed from the trading calendar. For daily-traded funds this is the next\nbank day whose cut-off time has not yet passed; for scheduled funds it is\ncomputed against the fund's trading cycle. Null when it cannot be computed.\n"}}}},"components/schemas/payment":{"id":"components/schemas/payment","kind":"json-schema","title":"payment","data":{"$id":"/models/payment/payment.yaml","title":"payment","type":"object","required":["account","amount","status","currency","paymentType"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/id"},"sortedId":{"$ref":"#/components/schemas/ulid"},"account":{"$ref":"#/components/schemas/uuid","description":"UUID of account"},"amount":{"type":"number","description":"Payment amount"},"paymentType":{"type":"string","description":"Payment type","enum":["bank_payout"]},"clientRef":{"$ref":"#/components/schemas/client_ref"},"executorRef":{"$ref":"#/components/schemas/executor_ref"},"status":{"title":"Payment status","type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment is pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment is completed and transaction is processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment is settled and transaction has been created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment is canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refunded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment is refunded"},"children":[]}]}]}]}],"enum":["new","pending","complete","failed","settled","canceled","refunded"]},"reason":{"type":["string","null"],"description":"Reason of failure"},"reasonCode":{"type":["string","null"],"description":"Bankgiro error code"},"currency":{"type":"string","description":"Three letter ISO currency code","pattern":"^[A-Z]{3}$","example":"SEK","const":"SEK","default":"SEK"},"createdDate":{"type":"string","format":"date-time","description":"Date when created","example":"2018-12-13T23:59:00.001Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when last modified","example":"2018-12-13T23:59:00.001Z","readOnly":true}}}},"components/schemas/savingsplan":{"id":"components/schemas/savingsplan","kind":"json-schema","title":"savingsPlan","data":{"$id":"/models/savingsplan/savingsplan.yaml","title":"savingsPlan","type":"object","required":["id","account","periodicity","instruments"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"ID of savings plan"},"account":{"$ref":"#/components/schemas/uuid","description":"Fondo account ID"},"bankAccount":{"$ref":"#/components/schemas/uuid","description":"Payment account ID used for autogiro"},"periodicity":{"type":"string","enum":["monthly"]},"day":{"type":"number","description":"Day of the month to charge","minimum":1,"maximum":31},"instruments":{"description":"Instrument allocations with fixed amounts","type":"array","items":{"type":"object","required":["instrument","amount"],"properties":{"instrument":{"type":"string","description":"Instrument ID"},"amount":{"type":"number","description":"Amount in SEK","minimum":1}}}}}}},"components/schemas/status-2":{"id":"components/schemas/status-2","kind":"json-schema","title":"status-2","data":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Pending verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Active, ready for withdrawals"},"children":[]}]}]}]}],"enum":["pending","rejected","active"]}},"components/schemas/journey_callback":{"id":"components/schemas/journey_callback","kind":"json-schema","title":"Journey callback","data":{"$id":"/models/journey/journey_callback.yaml","title":"Journey callback","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback at the partner will be called with status of the journey, such as when it is completed or aborted due to end-user decision or error."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback information will also be sent over websocket if active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scope parameter can be any value, BASE64 encoded, and used to keep state on partners end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback will be retried 10 times for any other status code than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure it is Fondo calling the callback URL, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to match."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fondo will also provide the Fondo source IP address."},"children":[]}]}]}],"oneOf":[{"title":"error","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"The ID of web journey."},"context":{"type":["string","null"],"description":"Where user exited the journey. On error on cancel, if applicable.","example":"createaccountsign"},"status":{"enum":["error"]},"error":{"type":"object","oneOf":[{"title":"createAccount","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — End-user related process aborted the journey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTH_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — End-user could not be authenticated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYC_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Know Your Customer related process aborted the journey"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — An unspecified error occurred"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfer of fund units or cash had an error; account is rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SIGN_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Error during signing"},"children":[]}]}]}]}],"enum":["USER_ERROR","AUTH_ERROR","KYC_ERROR","OTHER_ERROR","TRANSFER_ERROR","SIGN_ERROR"]},"journeyType":{"type":"string","title":"createAccount","enum":["createAccount"]}}}],"description":"Any errors occurring during journey"},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."}}},{"title":"canceled","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"The ID of web journey."},"context":{"type":["string","null"],"description":"Where user exited the journey. On error on cancel, if applicable.","example":"createaccountsign"},"status":{"type":"string","title":"canceled","enum":["canceled"]},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."}}},{"title":"pending","properties":{"id":{"description":"The ID of web journey.","$ref":"#/components/schemas/uuid"},"status":{"type":"string","title":"pending","enum":["pending"]},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."}}},{"title":"expired","properties":{"id":{"description":"The ID of web journey.","$ref":"#/components/schemas/uuid"},"status":{"type":"string","title":"expired","enum":["expired"]},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."}}},{"title":"complete","properties":{"id":{"description":"The ID of web journey.","$ref":"#/components/schemas/uuid"},"status":{"type":"string","title":"complete","enum":["complete"]},"scope":{"maxLength":768,"type":["string","null"],"description":"BASE64 encoded partner specific data attached to the journey, such as encrypted data containing session information. It will be passed back to callback."},"result":{"type":"object","description":"Result of journey","oneOf":[{"title":"createAccount result","properties":{"journeyType":{"enum":["createAccount"]},"account":{"description":"account created in journey","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of account"},"status":{"$ref":"#/components/schemas/status"},"accountType":{"$ref":"#/components/schemas/accountType"},"serviceType":{"$ref":"#/components/schemas/serviceType"}}},"bankAccounts":{"description":"accounts registered with allocation plan or for withdrawal","type":"object","additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of payment account"},"status":{"$ref":"#/components/schemas/status-2"},"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}},"transfers":{"description":"If transfers from other custodian was created, the results are provded here. One item per account.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["cash"],"description":"Type of transfer"},"custodian":{"$ref":"#/components/schemas/uuid","description":"ID matching an institution."},"account":{"type":"string","description":"Account number at institution","example":"1223456789"}}}},"allocationPlan":{"description":"If an allocationPlan was created. The results are provided here\n","type":"object","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of allocation plan"},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of bank account"},"iban":{"type":"string","description":"IBAN (ISO 13616, International Bank Account Number)","example":"SE7280000810340009783242"}}},"instruments":{"description":"Instrument allocations. The sum of all allocations must be exactly 100.","type":"array","example":[{"instrument":"SE0000810798SEK","allocation":100}],"items":{"type":"object","properties":{"instrument":{"description":"Instrument ID","type":"string","example":"SE0000810798SEK"},"allocation":{"type":"number","example":100,"description":"Allocation in percent for this instrument"}}}}}}}},{"title":"updateAllocationPlan","additionalProperties":false,"properties":{"journeyType":{"type":"string","title":"updateAllocationPlan","enum":["updateAllocationPlan"]},"allocationPlan":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/uuid","description":"Fondo account"},"paymentAccount":{"type":"object","description":"The details of the bank account to charge from (autogiro)","properties":{"id":{"$ref":"#/components/schemas/uuid","description":"id of payment account"}}}}}}},{"title":"kycRenewal","additionalProperties":false,"properties":{"journeyType":{"type":"string","title":"kycRenewal","enum":["kycRenewal"]}}},{"title":"addBankAccount","additionalProperties":false,"properties":{"journeyType":{"type":"string","title":"addBankAccount","enum":["addBankAccount"]}}}]}}}]}},"schema_39":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"oneOf":[{"type":"string","title":"invalid_request","enum":["invalid_request"],"example":"invalid_request","description":"The request is missing a required parameter, includes an\nunsupported parameter value (other than grant type),\nrepeats a parameter, includes multiple credentials,\nutilizes more than one mechanism for authenticating the\nclient, or is otherwise malformed.\n"},{"type":"string","enum":["invalid_client"],"title":"invalid_client","example":"invalid_client","description":"Client authentication failed (e.g., unknown client, no\nclient authentication included, or unsupported\nauthentication method)\n"},{"type":"string","enum":["invalid_grant"],"title":"invalid_grant","example":"invalid_grant","description":"The provided authorization grant (e.g., authorization\ncode, resource owner credentials) is\ninvalid, expired, revoked, does not match the redirection\nURI used in the authorization request, or was issued to\nanother client.\n"},{"type":"string","enum":["unauthorized_client"],"title":"unauthorized_client","example":"unauthorized_client","description":"The authenticated client is not authorized to use this\nauthorization grant type.\n"},{"type":"string","enum":["unsupported_grant_type"],"title":"unsupported_grant_type","example":"unsupported_grant_type","description":"The authorization grant type is not supported by the\nauthorization server.\n"},{"type":"string","enum":["invalid_scope"],"title":"invalid_scope","example":"invalid_scope","description":"The requested scope is invalid, unknown, malformed, or\nexceeds the scope granted by the resource owner.\n"}]},"error_description":{"type":"string","title":"error_description","description":"Description of error","example":"This is an error description"}}},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"string","enum":["server_error"],"description":"Error code"},"error_description":{"type":"string","description":"Description of error"}}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"string","enum":["service_unavailable"],"description":"Error code"},"error_description":{"type":"string","description":"Description of error"}}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"$ref":"#/components/schemas/id"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"string","example":"01ARZ3NDEKTSV4RRFFQ69G5FAV"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"number","example":100},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2024-01-01T00:00:01.000Z"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"string","pattern":"(19|20)[0-9]{2}[0-9]{2}[0-9]{4}"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"$id":"/models/id.yaml","title":"id","description":"ID (UUID) of object","readOnly":true,"$ref":"#/components/schemas/uuid"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/account"}},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"string","enum":["invalid_request"],"description":"Error code"},"error_description":{"type":"string","description":"Description of error"}}},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"string","enum":["unauthorized"],"description":"Error code"},"error_description":{"type":"string","description":"Description of error"}}},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"string","enum":["forbidden"],"description":"Error code"},"error_description":{"type":"string","description":"Description of error"}}},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ssn"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"$ref":"#/components/schemas/crn"},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2025-01-01"},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2025-03-01"},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/performance_entry"}},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"string","enum":["not_found"],"description":"Error code"},"error_description":{"type":"string","description":"Description of error"}}},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"object","properties":{"order":{"type":"boolean","description":"are all expected kycs completed for orders to be allowed?\n"},"withdrawal":{"type":"boolean","description":"are all expected kycs completed for withdrawals to be allowed?\n"}}},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/transfer"}},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/cash_transaction"}},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/fund_transaction"}},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"string"},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/agreement_type"},"example":[{"key":"account","swe":"Kontoavtal","createdDate":"2024-01-15T10:30:00Z"},{"key":"power_of_attorney","swe":"Fullmakt","createdDate":"2024-02-20T14:45:00Z"}]},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/client_base"}},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/instrument"}},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/custodian_base"}},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"$ref":"#/components/schemas/journey_callback"},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/allocation_plan_base"}},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"$ref":"#/components/schemas/uuid"},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2025-12-31"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"string","enum":["too_many_requests"],"description":"Error code"},"error_description":{"type":"string","description":"Description of error"}}},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/payment"}},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/order"}},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"string","example":"de9b6d5e-bda0-44f6-9193-f241014f18d5"},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"string","example":"subscription"},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"object","properties":{"pong":{"type":"string","format":"date-time","description":"Time request received at server","example":"2019-11-10T01:20:00.000Z"}}},"id":"schema_77"}},"exampleStore":{},"securitySchemeStore":{"oAuth":{"id":"oAuth","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange OAuth 2.0 Client Credentials: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `client_secret' for a short-lived bearer token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token grants access to all clients (power of attorney assignees) under your partner."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/v2/partner/auth/token","scopes":{}}}}},"servers":[{"url":"https://api.sandbox.fondo.se","description":"Sandbox"},{"url":"https://api.npc.fondo.se","description":"NPC"},{"url":"https://api.fondo.se","description":"Production"}],"logo":{"imageUrl":"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA4MiA4MiI+PGRlZnM+PHN0eWxlPi5jbHMtMXtmaWxsOiMxODU5ZmY7fS5jbHMtMntmaWxsOiNmZGZkZmM7fTwvc3R5bGU+PC9kZWZzPjx0aXRsZT5Gb25kbyAtIE1haWwgZm9vdGVyIC0gbnkgYnJhbmRpbmc8L3RpdGxlPjxnIGlkPSJMYWdlcl8xIiBkYXRhLW5hbWU9IkxhZ2VyIDEiPjxyZWN0IGNsYXNzPSJjbHMtMSIgd2lkdGg9IjgyIiBoZWlnaHQ9IjgyIi8+PC9nPjxnIGlkPSJMYWdlcl8yIiBkYXRhLW5hbWU9IkxhZ2VyIDIiPjxwYXRoIGNsYXNzPSJjbHMtMiIgZD0iTTIzLjc0LDM2LjA4YTUuNTgsNS41OCwwLDEsMCw1LjU3LDUuNThBNS41OCw1LjU4LDAsMCwwLDIzLjc0LDM2LjA4Wm0wLDguMTZhMi4zNCwyLjM0LDAsMCwxLTIuNDEtMi41NSwyLjQxLDIuNDEsMCwxLDEsNC44MSwwQTIuMzMsMi4zMywwLDAsMSwyMy43NCw0NC4yNFoiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDEgMSkiLz48cmVjdCBjbGFzcz0iY2xzLTIiIHg9IjEwLjc5IiB5PSIzMy4zIiB3aWR0aD0iMTAuMDEiIGhlaWdodD0iMy41OCIvPjxyZWN0IGNsYXNzPSJjbHMtMiIgeD0iMTAuNzkiIHk9IjQ0LjM0IiB3aWR0aD0iMy41OCIgaGVpZ2h0PSIzLjU4Ii8+PHJlY3QgY2xhc3M9ImNscy0yIiB4PSIxMC43OSIgeT0iMzguODIiIHdpZHRoPSI2LjQzIiBoZWlnaHQ9IjMuNTgiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik02MC42LDM2LjA4YTUuNTgsNS41OCwwLDEsMCw1LjU4LDUuNThBNS41OCw1LjU4LDAsMCwwLDYwLjYsMzYuMDhabTAsOC4xNmEyLjM0LDIuMzQsMCwwLDEtMi40MS0yLjU1LDIuNDEsMi40MSwwLDEsMSwyLjQxLDIuNTVaIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgxIDEpIi8+PHJlY3QgY2xhc3M9ImNscy0yIiB4PSI2OC4zMiIgeT0iNDQuMzQiIHdpZHRoPSIzLjU4IiBoZWlnaHQ9IjMuNTgiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0zNy4wOSwzNi4wOEEzLjY2LDMuNjYsMCwwLDAsMzQsMzcuN1YzNi40NGgtMy4yVjQ2LjkySDM0VjQxLjM3YzAtMS42Mi43LTIuMjYsMS44NS0yLjI2czEuODIuNywxLjgyLDIuMzJ2NS40OWgzLjJ2LTYuMkM0MC44NSwzNy41OCwzOSwzNi4wOCwzNy4wOSwzNi4wOFoiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDEgMSkiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik01MC4zLDM3LjE4YTQuMTIsNC4xMiwwLDAsMC0yLjgyLTEuMDcsNS4zOCw1LjM4LDAsMCwwLTUuMTYsNS41OCw1LjM2LDUuMzYsMCwwLDAsNS4xLDUuNTgsMy45MywzLjkzLDAsMCwwLDIuODgtMS4xOHYuODVoMy4yVjMyLjNINTAuM1pNNDgsNDQuMjRhMi41NSwyLjU1LDAsMCwxLDAtNS4xLDIuMzQsMi4zNCwwLDAsMSwyLjQzLDIuNTVBMi4zNCwyLjM0LDAsMCwxLDQ4LDQ0LjI0WiIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMSAxKSIvPjwvZz48L3N2Zz4=","backgroundColor":"transparent"}},"options":{"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"curl"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"C#"},{"lang":"Python"},{"lang":"Java"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/api.json?download"},{"url":"/_bundle/openapi/api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Fondo Partner API","description":"# Overview\n\nThis API is intended for registered partners in agreement with Fondo.\n\nThe API is subject to change.\n"}},"baseSlug":"/openapi/api","routesMapping":{}}