{"openapi" : "3.1.0", "info" : {"title" : "Svea Bank API", "version" : "", "description" : "\r\n# Errors\r\n\r\nAll endpoints have the same error contract. Available errors are described at [\/error-code](https:\/\/sveabankapi.svea.com\/error-code)\r\n\r\nAvailable content types for the list of errors are:\r\n* Accept: application\/json\r\n* Accept: text\/html\r\n"}, "servers" : [{"url" : "https:\/\/bankapidemo.svea.com", "description" : "Developer environment", "variables" : {}}, {"url" : "https:\/\/bankapi.svea.com", "description" : "Production environment", "variables" : {}}], "tags" : [{"name" : "Authentication", "description" : "Authentication of an end user in the internet bank."}, {"name" : "Signing", "description" : "Signing of requests that require signing, e.g. payments."}, {"name" : "Bank Account", "description" : "All bank accounts share the same JSON representation, with varying properties depending on what type of account it is. Accounts come in different flavors, such as:\r\n\r\n* Transaction accounts\r\n* Savings accounts\r\n* Credit accounts\r\n"}, {"name" : "PSU", "description" : "The end user can get the profile for the PSU (Payment Service User)."}, {"name" : "Delegate", "description" : "The end user can handle who has access, and access type to a PSU."}, {"name" : "Payment", "description" : "View, register and send payments etc."}, {"name" : "International Payment", "description" : "International Payment"}, {"name" : "Creditor", "description" : "Creditor"}, {"name" : "Loan Account", "description" : "View loan accounts, interest rate and amortization."}, {"name" : "Inbox", "description" : "The end user can view messages and notifications sent from the bank."}, {"name" : "Card", "description" : "The end user can view debit and credit cards, edit PIN, etc."}, {"name" : "Autogiro", "description" : "View autogiro consents"}, {"name" : "E-Invoice", "description" : "The end user can view and manage E-Invoice issuers and consents.\r\n\r\n* The E-Invoice issuer is someone offering the E-Invoice service\r\n* A consent is when you give permissions receiving E-Invoice from an issuer"}, {"name" : "Swish"}, {"name" : "Swish Person"}, {"name" : "Swish Technical Supplier"}, {"name" : "Avanza"}], "paths" : {"\/auth\/start" : {"post" : {"operationId" : "authstartpost", "tags" : ["Authentication"], "summary" : "Start an authentication process", "description" : "\r\nAuthenticating with [**BankID**](https:\/\/www.bankid.com\/utvecklare\/guider\/teknisk-integrationsguide\/rp-anvaendarfall) can be started in one of two different ways:\r\n* Use the provided bankIdToken to start BankID on the same device. For instructions for specific OS:es, see this [integration guide](https:\/\/www.bankid.com\/en\/utvecklare\/guider\/teknisk-integrationsguide\/programstart). The value of bankIdToken in the response should be used for autostarttoken when launching the app.\r\n* Present a QR code for the user to scan. The QR code should be encoded with the value of qrCode, exactly as is. The code is only valid for a very short timespan, and you will have to continuoulsy update it with the code received in the status endpoint. This is the only option if BankID is not installed on the same device.\r\n\r\nUpon a successful request, a BankID token and a QR code is received, and the client takes appropriate action, depending on the method chosen.\r\n\r\nFrom here, do the following:\r\n* Poll [**Get the status of an authentication process**](\/operations\/authstatuspost), and upon receiving 'complete', call [**Verify and complete a authentication process**](\/operations\/authverifypost)\r\n\r\nFor more information regarding BankID, see the [**BankID resource**](https:\/\/baasdeveloperdemo.svea.com\/resources\/bank-id) in the Developer Portal\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdNumber" : {"type" : ["string", "null"], "examples" : ["199403086854"], "pattern" : "^[1-9][0-9]{11}$", "description" : "\r\nRequired if mode = 'FAKE'. Should be null otherwise. If specified must be a valid swedish person number.\r\n"}, "mode" : {"type" : "string", "examples" : ["FAKE"], "enum" : ["FAKE", "TEST", "PROD"], "description" : "\r\nAvailable modes:\r\n* `FAKE` - No device needed, will instantly receive status complete.\r\n* `TEST` - Physical test device needed.\r\n* `PROD` - Regular. Only mode supported in production. Not available below production.\r\n"}, "provider" : {"type" : ["string", "null"], "examples" : ["eid"], "description" : "This is a temporary flag to opt in to the QR flow"}, "tenant" : {"type" : "string", "examples" : ["Demo-8ma2Vf"]}}, "required" : ["mode", "bankIdNumber", "tenant"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdToken" : {"type" : "string", "examples" : ["ca8538ea-124e-4f06-8395-3febf5065710"]}, "orderTime" : {"type" : "string", "examples" : ["2025-10-28T13:57:27.1719088Z"], "format" : "date-time"}, "qrCode" : {"type" : "string", "examples" : ["bankid.7668e339-43df-420d-9d73-56e81ae0a6d1.1.e07c99ac6729990cfcc06bb304fa0b76fd6f0031045a143927e28be64a3a45b9"]}}, "required" : ["bankIdToken", "orderTime", "qrCode"]}}}}}}}, "\/auth\/status" : {"post" : {"operationId" : "authstatuspost", "tags" : ["Authentication"], "summary" : "Get the status of an authentication process", "parameters" : [{"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdToken" : {"type" : "string", "examples" : ["3764cca2-169d-4a1d-9a8b-949cb68e0faa"]}}, "required" : ["bankIdToken"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"qrCode" : {"type" : ["string", "null"], "examples" : ["bankid.7668e339-43df-420d-9d73-56e81ae0a6d1.3.c52c202da6c59624ea24fbc21f4628d9af48708fb56c7b12d721b7ea64b0eb59"], "description" : "Will have a value until the user has successfully initiated the authentication in their BankID app, afterwards it will be null."}, "status" : {"type" : "string", "examples" : ["successful"], "enum" : ["successful", "pending"]}}, "required" : ["status", "qrCode"]}}}}}}}, "\/auth\/verify" : {"post" : {"operationId" : "authverifypost", "tags" : ["Authentication"], "summary" : "Verify and complete an authentication process", "description" : "\r\nThe client sends a request, with a prolonged timeout if necessary, using the appropriate payload.\r\nA bearer token is received, later used to authenticate calls.\r\n\r\nA list of account holders the user has access to is also included. Each holder will have a list of capabilities,\r\nselected from a set of capabilities that have user access level conditions. All other endpoints may be assumed to give access to all users,\r\nso the list of capabilities is not an exhaustive list.\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdToken" : {"type" : "string", "examples" : ["3764cca2-169d-4a1d-9a8b-949cb68e0faa"]}}, "required" : ["bankIdToken"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdUser" : {"type" : "object", "properties" : {"bankIdNumber" : {"type" : "string", "examples" : ["199403086854"]}, "correspondenceName" : {"type" : "string", "examples" : ["Testy McTestface"]}, "firstName" : {"type" : "string", "examples" : ["Testy"]}, "lastName" : {"type" : "string", "examples" : ["McTestface"]}}, "required" : ["bankIdNumber", "correspondenceName", "firstName", "lastName"]}, "bearerToken" : {"type" : "string", "examples" : ["eyJhbGciOiJSUzI1NiIsImtpZCI6IjA2RThEQTgwMDQ..."]}, "psus" : {"type" : "array", "items" : {"type" : "object", "properties" : {"accessLevel" : {"type" : "string", "examples" : ["restrictedLevel"], "enum" : ["restrictedLevel", "fullAccessLevel", "approveLevel", "prepareLevel", "cardHolderLevel"], "description" : "**Note!** New accessLevels are created upon request by the tenant and must be supported in the clients before delivery to production."}, "actionRequired" : {"type" : "array", "items" : {"type" : "object", "properties" : {"action" : {"type" : "string", "examples" : ["kyc"], "enum" : ["kyc"], "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them."}, "validUntil" : {"type" : "string", "examples" : ["2020-12-24"]}}, "required" : ["action", "validUntil"]}}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : ["sendPaymentOrders"], "enum" : ["delegates", "bankAccounts", "readPayment", "registerPaymentOrders", "sendPaymentOrders", "sendInternationalPayments", "creditor", "editEInvoice", "readEInvoice", "autogiro", "cards", "inbox", "profile", "enrollToSwish", "readSwishEnrollments"]}}, "capabilitiesContext" : {"type" : "array", "items" : {"discriminator" : {"propertyName" : "accessType"}, "oneOf" : [{"$ref" : "#\/components\/schemas\/AccountAccessCapability"}], "description" : "Additional information about the individual bank account access rights."}}, "delegateId" : {"type" : "string", "examples" : ["7aa2dfea-2b0c-45cb-8f03-4743c284417d"]}, "psuContext" : {"oneOf" : [{"title" : "person", "type" : "object", "properties" : {"correspondenceName" : {"type" : "string", "examples" : ["Testy McTestface"]}, "personKey" : {"type" : "string", "examples" : ["199403086854"]}}, "required" : ["personKey", "correspondenceName"]}, {"title" : "organization", "type" : "object", "properties" : {"name" : {"type" : "string", "examples" : ["Testy McTestface"]}, "organizationKey" : {"type" : "string", "examples" : ["199403086854"]}}, "required" : ["organizationKey", "name"]}]}, "psuId" : {"type" : "string", "examples" : ["febbe8f2-bd6b-4e53-89c6-e89ca92ff5ee"]}, "psuType" : {"type" : "string", "examples" : ["person"], "enum" : ["person", "organization", "foreignOrganization"], "description" : "**Note!** New psuTypes can be created upon request from the tenant and must be supported in the clients before delivery to production."}}, "required" : ["actionRequired", "psuId", "psuContext", "delegateId", "psuType", "capabilities", "accessLevel", "capabilitiesContext"]}}, "refreshToken" : {"type" : ["string", "null"], "examples" : ["27a5dc2d363357ab4f32ff5..."]}}, "required" : ["psus", "bearerToken", "refreshToken", "bankIdUser"]}}}}}}}, "\/auth\/refresh" : {"post" : {"operationId" : "authrefreshpost", "tags" : ["Authentication"], "summary" : "Refresh an expired bearer token", "description" : "\r\nIn case you get an unauthorized response from a protected endpoint with the code expired_token (or if you just feel like it),\r\nyou can try to refresh the bearer token using the corresponding longer lived refresh token.\r\nA new bearer token and a new refresh token is received, both with prolonged expiration.\r\nThe refresh token used in the request is now invalidated, and the one received here must be used for future refreshes.\r\nNote that the old bearer token might still be valid though.\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"refreshToken" : {"type" : "string", "examples" : ["3693fd591a812118607ab7c7cedf1b3697dd37241923a440772facb66197b131"]}}, "required" : ["refreshToken"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdUser" : {"type" : "object", "properties" : {"bankIdNumber" : {"type" : "string", "examples" : ["199403086854"]}, "correspondenceName" : {"type" : "string", "examples" : ["Testy McTestface"]}, "firstName" : {"type" : "string", "examples" : ["Testy"]}, "lastName" : {"type" : "string", "examples" : ["McTestface"]}}, "required" : ["bankIdNumber", "correspondenceName", "firstName", "lastName"]}, "bearerToken" : {"type" : "string", "examples" : ["eyJhbGciOiJSUzI1NiIsImtpZCI6IjA2RThEQTgwMDQ..."]}, "psus" : {"type" : "array", "items" : {"type" : "object", "properties" : {"accessLevel" : {"type" : "string", "examples" : ["restrictedLevel"], "enum" : ["restrictedLevel", "fullAccessLevel", "approveLevel", "prepareLevel", "cardHolderLevel"], "description" : "**Note!** New accessLevels are created upon request by the tenant and must be supported in the clients before delivery to production."}, "actionRequired" : {"type" : "array", "items" : {"type" : "object", "properties" : {"action" : {"type" : "string", "examples" : ["kyc"], "enum" : ["kyc"], "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them."}, "validUntil" : {"type" : "string", "examples" : ["2020-12-24"]}}, "required" : ["action", "validUntil"]}}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : ["sendPaymentOrders"], "enum" : ["delegates", "bankAccounts", "readPayment", "registerPaymentOrders", "sendPaymentOrders", "sendInternationalPayments", "creditor", "editEInvoice", "readEInvoice", "autogiro", "cards", "inbox", "profile", "enrollToSwish", "readSwishEnrollments"]}}, "capabilitiesContext" : {"type" : "array", "items" : {"discriminator" : {"propertyName" : "accessType"}, "oneOf" : [{"$ref" : "#\/components\/schemas\/AccountAccessCapability"}], "description" : "Additional information about the individual bank account access rights."}}, "delegateId" : {"type" : "string", "examples" : ["7aa2dfea-2b0c-45cb-8f03-4743c284417d"]}, "psuContext" : {"oneOf" : [{"title" : "person", "type" : "object", "properties" : {"correspondenceName" : {"type" : "string", "examples" : ["Testy McTestface"]}, "personKey" : {"type" : "string", "examples" : ["199403086854"]}}, "required" : ["personKey", "correspondenceName"]}, {"title" : "organization", "type" : "object", "properties" : {"name" : {"type" : "string", "examples" : ["Testy McTestface"]}, "organizationKey" : {"type" : "string", "examples" : ["199403086854"]}}, "required" : ["organizationKey", "name"]}]}, "psuId" : {"type" : "string", "examples" : ["febbe8f2-bd6b-4e53-89c6-e89ca92ff5ee"]}, "psuType" : {"type" : "string", "examples" : ["person"], "enum" : ["person", "organization", "foreignOrganization"], "description" : "**Note!** New psuTypes can be created upon request from the tenant and must be supported in the clients before delivery to production."}}, "required" : ["actionRequired", "psuId", "psuContext", "delegateId", "psuType", "capabilities", "accessLevel", "capabilitiesContext"]}}, "refreshToken" : {"type" : ["string", "null"], "examples" : ["27a5dc2d363357ab4f32ff5..."]}}, "required" : ["psus", "bearerToken", "refreshToken", "bankIdUser"]}}}}}}}, "\/auth\/cancel" : {"post" : {"operationId" : "authcancelpost", "tags" : ["Authentication"], "summary" : "Cancel an authentication process", "description" : "\r\nIn case the client want to abort the authentication process after calling [**Start an authentication process**](\/operations\/authstartpost) this is\r\nthe endpoint to call to make a graceful cancellation of authentication.\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdToken" : {"type" : "string", "examples" : ["3764cca2-169d-4a1d-9a8b-949cb68e0faa"]}}, "required" : ["bankIdToken"]}}}}, "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/auth\/user-info" : {"get" : {"operationId" : "authuserinfoget", "tags" : ["Authentication"], "summary" : "Get information about an authenticated user", "description" : "\r\nIn case you got your bearer token from another source and want the user data usually returned from [**Verify and complete an authentication process**](\/operations\/authverifypost), you can use this endpoint for that.\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdUser" : {"type" : "object", "properties" : {"bankIdNumber" : {"type" : "string", "examples" : ["199403086854"]}, "correspondenceName" : {"type" : "string", "examples" : ["Testy McTestface"]}, "firstName" : {"type" : "string", "examples" : ["Testy"]}, "lastName" : {"type" : "string", "examples" : ["McTestface"]}}, "required" : ["bankIdNumber", "correspondenceName", "firstName", "lastName"]}, "psus" : {"type" : "array", "items" : {"type" : "object", "properties" : {"accessLevel" : {"type" : "string", "examples" : ["restrictedLevel"], "enum" : ["restrictedLevel", "fullAccessLevel", "approveLevel", "prepareLevel", "cardHolderLevel"], "description" : "**Note!** New accessLevels are created upon request by the tenant and must be supported in the clients before delivery to production."}, "actionRequired" : {"type" : "array", "items" : {"type" : "object", "properties" : {"action" : {"type" : "string", "examples" : ["kyc"], "enum" : ["kyc"], "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them."}, "validUntil" : {"type" : "string", "examples" : ["2020-12-24"]}}, "required" : ["action", "validUntil"]}}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : ["sendPaymentOrders"], "enum" : ["delegates", "bankAccounts", "readPayment", "registerPaymentOrders", "sendPaymentOrders", "sendInternationalPayments", "creditor", "editEInvoice", "readEInvoice", "autogiro", "cards", "inbox", "profile", "enrollToSwish", "readSwishEnrollments"]}}, "capabilitiesContext" : {"type" : "array", "items" : {"discriminator" : {"propertyName" : "accessType"}, "oneOf" : [{"$ref" : "#\/components\/schemas\/AccountAccessCapability"}], "description" : "Additional information about the individual bank account access rights."}}, "delegateId" : {"type" : "string", "examples" : ["7aa2dfea-2b0c-45cb-8f03-4743c284417d"]}, "psuContext" : {"oneOf" : [{"title" : "person", "type" : "object", "properties" : {"correspondenceName" : {"type" : "string", "examples" : ["Testy McTestface"]}, "personKey" : {"type" : "string", "examples" : ["199403086854"]}}, "required" : ["personKey", "correspondenceName"]}, {"title" : "organization", "type" : "object", "properties" : {"name" : {"type" : "string", "examples" : ["Testy McTestface"]}, "organizationKey" : {"type" : "string", "examples" : ["199403086854"]}}, "required" : ["organizationKey", "name"]}]}, "psuId" : {"type" : "string", "examples" : ["febbe8f2-bd6b-4e53-89c6-e89ca92ff5ee"]}, "psuType" : {"type" : "string", "examples" : ["person"], "enum" : ["person", "organization", "foreignOrganization"], "description" : "**Note!** New psuTypes can be created upon request from the tenant and must be supported in the clients before delivery to production."}}, "required" : ["actionRequired", "psuId", "psuContext", "delegateId", "psuType", "capabilities", "accessLevel", "capabilitiesContext"]}}}, "required" : ["psus", "bankIdUser"]}}}}}}}, "\/sign\/start" : {"post" : {"operationId" : "signstartpost", "security" : [{"Bearer" : []}], "tags" : ["Signing"], "summary" : "Start a signing process", "description" : "\r\nTo complete a signing process, do the following:\r\n* Poll [**Get the status of a signing process**](\/operations\/signstatuspost), and upon receiving 'complete', call [**Verify and complete a signing process**](\/operations\/signverifypost)\r\n\r\nFor more information regarding BankID, see the [**BankID resource**](https:\/\/baasdeveloperdemo.svea.com\/resources\/bank-id) in the Developer Portal\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"mode" : {"type" : "string", "examples" : ["FAKE"], "enum" : ["FAKE", "TEST", "PROD"], "description" : "Available modes:\r\n* `FAKE` - No device needed, will instantly complete for any bankIdNumber.\r\n* `TEST` - Physical test device needed.\r\n* `PROD` - Regular. Only mode supported in production. Not available below production."}, "provider" : {"type" : ["string", "null"], "examples" : ["eid"], "description" : "This is a temporary flag to opt in to the QR flow"}, "signingToken" : {"type" : "string", "examples" : ["c83e7cbc-a7d9-4714-8ff1-d656f2243e8d"], "format" : "uuid"}}, "required" : ["signingToken", "mode"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdToken" : {"type" : "string", "examples" : ["b38e863f-a9d9-4ba9-999f-dac1f5e3aeb7"], "format" : "uuid"}, "orderTime" : {"type" : "string", "examples" : ["2025-10-28T13:57:27.1719088Z"], "format" : "date-time"}, "qrCode" : {"type" : "string", "examples" : ["bankid.7668e339-43df-420d-9d73-56e81ae0a6d1.1.e07c99ac6729990cfcc06bb304fa0b76fd6f0031045a143927e28be64a3a45b9"]}}, "required" : ["bankIdToken", "orderTime", "qrCode"]}}}}}}}, "\/sign\/status" : {"post" : {"operationId" : "signstatuspost", "security" : [{"Bearer" : []}], "tags" : ["Signing"], "summary" : "Get the status of a signing process", "parameters" : [{"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdToken" : {"type" : "string", "examples" : ["39fac731-5328-4896-a2a8-105c0bded0e6"], "format" : "uuid"}}, "required" : ["bankIdToken"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"qrCode" : {"type" : ["string", "null"], "examples" : ["bankid.7668e339-43df-420d-9d73-56e81ae0a6d1.3.c52c202da6c59624ea24fbc21f4628d9af48708fb56c7b12d721b7ea64b0eb59"], "description" : "Will have a value until the user has successfully initiated the signature in their BankID app, afterwards it will be null."}, "status" : {"type" : "string", "examples" : ["successful"], "enum" : ["successful", "pending"]}}, "required" : ["status", "qrCode"]}}}}}}}, "\/sign\/verify" : {"post" : {"operationId" : "signverifypost", "security" : [{"Bearer" : []}], "tags" : ["Signing"], "summary" : "Verify and complete a signing process", "description" : "The response after a signing depends on what type of resource that is signed.\r\n- [**Add a delegate**](\/operations\/psupsuIddelegatepost) - The response when adding a delegate is `202 Accepted` with an empty body\r\n- [**Delete a delegate**](\/operations\/psupsuIddelegatedelegateIddelete) - The response when deleting a delegate is `204 No Content`\r\n- [**Change access level for a delegate**](\/operations\/psupsuIddelegatedelegateIdaccesslevelput) - The response when changing the role of a delegate is `204 No Content`\r\n- [**Send registered payment orders**](\/operations\/psupsuIdpaymentordersendpost) - The response when sending registered payment orders is `202 Accepted` with a json body containing the payments\r\n- [**Set PIN**](\/operations\/psupsuIdcardcardIdpinput) - The response when changing PIN for a card is `204 No Content`\r\n- [**Get PAN**](\/operations\/psupsuIdcardcardIdpanpost) - The response when requesting PAN is `200 OK` with a json body containing the PAN and CVC2\r\n\r\n**Note!** New responses might be added at any time. These responses are always part of a flow and thus it's unlikely that a user signs a resource for a flow which isn't implemented by the client.", "parameters" : [{"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdToken" : {"type" : "string", "examples" : ["883b47ac-d2c7-49eb-9acb-ec845937417d"], "format" : "uuid"}}, "required" : ["bankIdToken"]}}}}}}, "\/sign\/cancel" : {"post" : {"operationId" : "signcancelpost", "security" : [{"Bearer" : []}], "tags" : ["Signing"], "summary" : "Cancel a signing process", "parameters" : [{"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankIdToken" : {"type" : "string", "examples" : ["883b47ac-d2c7-49eb-9acb-ec845937417d"], "format" : "uuid"}}, "required" : ["bankIdToken"]}}}}, "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}" : {"get" : {"operationId" : "psupsuIdget", "security" : [{"Bearer" : []}], "tags" : ["PSU"], "summary" : "Get profile for a PSU", "description" : "Returns the profile for the Payment Service User, PSU. Read more about the concepts Tenant, PSU and delegate in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/tenant-psu-delegate)", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"profileContext" : {"oneOf" : [{"title" : "person", "type" : "object", "properties" : {"addressLine1" : {"type" : "string", "examples" : ["TestysPlace"]}, "addressLine2" : {"type" : ["string", "null"], "examples" : ["Lägenhet 1337, 3 trappor"]}, "city" : {"type" : "string", "examples" : ["Stockholm"]}, "correspondenceName" : {"type" : "string", "examples" : ["Testy McTestface"]}, "email" : {"type" : ["string", "null"], "examples" : ["testy@noreply.com"]}, "firstName" : {"type" : "string", "examples" : ["Testy"]}, "lastName" : {"type" : "string", "examples" : ["McTestface"]}, "personId" : {"type" : "string", "examples" : ["d09523de-51ba-4803-ac40-2fe782ab60f0"], "format" : "uuid"}, "personKey" : {"type" : "string", "examples" : ["199403086854"]}, "personKeyDisplayName" : {"type" : "string", "examples" : ["940308-6854"]}, "phoneNumber" : {"type" : ["string", "null"], "examples" : ["555"]}, "zipCode" : {"type" : "string", "examples" : ["12345"]}}, "required" : ["addressLine1", "addressLine2", "city", "correspondenceName", "email", "firstName", "lastName", "personId", "personKey", "personKeyDisplayName", "phoneNumber", "zipCode"]}, {"title" : "organization", "type" : "object", "properties" : {"addressLine1" : {"type" : ["string", "null"], "examples" : ["Testvägen 1"]}, "addressLine2" : {"type" : ["string", "null"], "examples" : ["CO Testys Bolag AB"]}, "alternativeEmail" : {"type" : ["string", "null"], "examples" : ["testys@noreply.com"]}, "city" : {"type" : "string", "examples" : ["Stockholm"]}, "email" : {"type" : ["string", "null"], "examples" : ["testbolaget@noreply.com"]}, "name" : {"type" : "string", "examples" : ["Testbolaget AB"]}, "organizationId" : {"type" : "string", "examples" : ["90445962-aadc-41a2-b689-f1e5b534b235"], "format" : "uuid"}, "organizationKey" : {"type" : "string", "examples" : ["165520010009"]}, "organizationKeyDisplayName" : {"type" : "string", "examples" : ["552001-0009"]}, "organizationType" : {"type" : "string", "examples" : ["aktiebolag"], "enum" : ["aktiebolag", "enkeltBolag", "enskildFirma", "ekonomiskFörening", "utländskFilial", "handelsbolag", "kommanditbolag", "bostadsrättsförening", "ideellFörening", "övriga", "samfällighet", "stiftelseEllerFond", "offentligtBolag", "värdepappersfonder"]}, "phoneNumber" : {"type" : ["string", "null"], "examples" : ["23455626"]}, "zipCode" : {"type" : "string", "examples" : ["12345"]}}, "required" : ["addressLine1", "addressLine2", "alternativeEmail", "city", "email", "name", "organizationId", "organizationKey", "organizationKeyDisplayName", "organizationType", "phoneNumber", "zipCode"]}]}, "profileType" : {"type" : "string", "examples" : ["person"], "enum" : ["person", "organization"]}, "tenant" : {"type" : "string", "examples" : ["demo"]}}, "required" : ["tenant", "profileType", "profileContext"]}}}}}}}, "\/psu\/{psuId}\/delegate" : {"post" : {"operationId" : "psupsuIddelegatepost", "security" : [{"Bearer" : []}], "tags" : ["Delegate"], "summary" : "Add a delegate", "description" : "A delegate is a person, authenticated by BankID and associated with a unique PSU. Read more about the concepts Tenant, PSU and delegate in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/tenant-psu-delegate)\r\n\r\nThe first name, last name and correspondence name of the delegate are retrieved from https:\/\/www.statenspersonadressregister.se\/\r\n\r\nThis request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request. The response of the [**Verify**](\/operations\/signverifypost) request is `202 Accepted` with an empty body.\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"accessLevel" : {"type" : "string", "examples" : ["restrictedLevel"], "enum" : ["restrictedLevel", "fullAccessLevel", "approveLevel", "prepareLevel", "cardHolderLevel"], "description" : "**Note!** New accessLevels are created upon request by the tenant and must be supported in the clients before delivery to production."}, "accessLevelContext" : {"type" : ["array", "null"], "description" : "Additional information about the individual bank account access rights.", "items" : {"type" : "object", "properties" : {"accountAccessLevel" : {"type" : "string", "examples" : ["read"], "enum" : ["read", "preparePayment", "approvePayment"]}, "bankAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"]}}, "required" : ["bankAccountId", "accountAccessLevel"]}}, "personKey" : {"type" : "string", "examples" : ["199204049374"], "pattern" : "^(19|20)[0-9]{6}[0-9]{4}$"}}, "required" : ["personKey", "accessLevel", "accessLevelContext"]}}}}, "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "202" : {"description" : "Accepted", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}, "get" : {"operationId" : "psupsuIddelegateget", "security" : [{"Bearer" : []}], "tags" : ["Delegate"], "summary" : "List delegates", "description" : "A delegate is a person, authenticated by BankID and associated with a unique PSU. Read more about the concepts Tenant, PSU and delegate in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/tenant-psu-delegate)", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"accessLevel" : {"type" : "string", "examples" : ["restrictedLevel"], "enum" : ["restrictedLevel", "fullAccessLevel", "approveLevel", "prepareLevel", "cardHolderLevel"], "description" : "**Note!** New accessLevels are created upon request by the tenant and must be supported in the clients before delivery to production."}, "accessLevelContext" : {"type" : ["array", "null"], "description" : "Additional information about the individual bank account access rights.", "items" : {"type" : "object", "properties" : {"accountAccessLevel" : {"type" : "string", "examples" : ["read"], "enum" : ["read", "preparePayment", "approvePayment"]}, "bankAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"]}}, "required" : ["bankAccountId", "accountAccessLevel"]}}, "correspondenceName" : {"type" : "string", "examples" : ["Anna Andersson"]}, "delegateId" : {"type" : "string", "examples" : ["4a1fd043-a5ad-4bf1-894c-007fed391c63"], "format" : "uuid"}, "email" : {"type" : ["string", "null"]}, "personKey" : {"type" : "string", "examples" : ["194604296485"]}, "phoneNumber" : {"type" : ["object", "null"], "properties" : {"countryCode" : {"type" : "string", "examples" : ["+46"]}, "domesticNumber" : {"type" : "string", "examples" : ["0701234567"], "description" : "A potential leading 0 (zero), dash or hyphen, and white spaces will be cleaned from the input."}}, "required" : ["countryCode", "domesticNumber"]}}, "required" : ["delegateId", "personKey", "correspondenceName", "phoneNumber", "email", "accessLevel", "accessLevelContext"]}}}}}}}}, "\/psu\/{psuId}\/delegate\/{delegateId}" : {"get" : {"operationId" : "psupsuIddelegatedelegateIdget", "security" : [{"Bearer" : []}], "tags" : ["Delegate"], "summary" : "Get a single delegate", "description" : "A delegate is a person, authenticated by BankID and associated with a unique PSU. Read more about the concepts Tenant, PSU and delegate in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/tenant-psu-delegate)", "parameters" : [{"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"accessLevel" : {"type" : "string", "examples" : ["restrictedLevel"], "enum" : ["restrictedLevel", "fullAccessLevel", "approveLevel", "prepareLevel", "cardHolderLevel"], "description" : "**Note!** New accessLevels are created upon request by the tenant and must be supported in the clients before delivery to production."}, "accessLevelContext" : {"type" : ["array", "null"], "description" : "Additional information about the individual bank account access rights.", "items" : {"type" : "object", "properties" : {"accountAccessLevel" : {"type" : "string", "examples" : ["read"], "enum" : ["read", "preparePayment", "approvePayment"]}, "bankAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"]}}, "required" : ["bankAccountId", "accountAccessLevel"]}}, "correspondenceName" : {"type" : "string", "examples" : ["Anna Andersson"]}, "delegateId" : {"type" : "string", "examples" : ["4a1fd043-a5ad-4bf1-894c-007fed391c63"], "format" : "uuid"}, "email" : {"type" : ["string", "null"]}, "personKey" : {"type" : "string", "examples" : ["194604296485"]}, "phoneNumber" : {"type" : ["object", "null"], "properties" : {"countryCode" : {"type" : "string", "examples" : ["+46"]}, "domesticNumber" : {"type" : "string", "examples" : ["0701234567"], "description" : "A potential leading 0 (zero), dash or hyphen, and white spaces will be cleaned from the input."}}, "required" : ["countryCode", "domesticNumber"]}}, "required" : ["delegateId", "personKey", "correspondenceName", "phoneNumber", "email", "accessLevel", "accessLevelContext"]}}}}}}, "delete" : {"operationId" : "psupsuIddelegatedelegateIddelete", "security" : [{"Bearer" : []}], "tags" : ["Delegate"], "summary" : "Delete a delegate", "description" : "This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request. The response of the [**Verify**](\/operations\/signverifypost) request is `204 Not Content` with an empty body.\r\n\r\nA delegate is a person, authenticated by BankID and associated with a unique PSU. Read more about the concepts Tenant, PSU and delegate in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/tenant-psu-delegate)\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/delegate\/{delegateId}\/access-level" : {"put" : {"operationId" : "psupsuIddelegatedelegateIdaccesslevelput", "security" : [{"Bearer" : []}], "tags" : ["Delegate"], "summary" : "Change access level for a delegate", "description" : "This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request. The response of the [**Verify**](\/operations\/signverifypost) request is `204 Not Content` with an empty body.\r\n\r\nA delegate is a person, authenticated by BankID and associated with a unique PSU. Read more about the concepts Tenant, PSU and delegate in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/tenant-psu-delegate)\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"accessLevel" : {"type" : "string", "examples" : ["restrictedLevel"], "enum" : ["restrictedLevel", "fullAccessLevel", "approveLevel", "prepareLevel", "cardHolderLevel"], "description" : "**Note!** New accessLevels are created upon request by the tenant and must be supported in the clients before delivery to production."}, "accessLevelContext" : {"type" : ["array", "null"], "description" : "Additional information about the individual bank account access rights.", "items" : {"type" : "object", "properties" : {"accountAccessLevel" : {"type" : "string", "examples" : ["read"], "enum" : ["read", "preparePayment", "approvePayment"]}, "bankAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"]}}, "required" : ["bankAccountId", "accountAccessLevel"]}}}, "required" : ["accessLevel", "accessLevelContext"]}}}}, "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "202" : {"description" : "Accepted", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/delegate\/{delegateId}\/email" : {"put" : {"operationId" : "psupsuIddelegatedelegateIdemailput", "security" : [{"Bearer" : []}], "tags" : ["Delegate"], "summary" : "Change email for a delegate", "description" : "A delegate is a person, authenticated by BankID and associated with a unique PSU. Read more about the concepts Tenant, PSU and delegate in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/tenant-psu-delegate)\r\n\r\nWhen email is updated with value null, the email will be removed.\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"email" : {"type" : ["string", "null"], "examples" : ["my@email.com"]}}, "required" : ["email"]}}}}, "responses" : {"202" : {"description" : "Accepted", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/delegate\/{delegateId}\/phone-number" : {"put" : {"operationId" : "psupsuIddelegatedelegateIdphonenumberput", "security" : [{"Bearer" : []}], "tags" : ["Delegate"], "summary" : "Change phone number for a delegate", "description" : "When phone number is updated with value null, the phone number will be removed.\r\n\r\nA delegate is a person, authenticated by BankID and associated with a unique PSU. Read more about the concepts Tenant, PSU and delegate in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/tenant-psu-delegate)\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"countryCode" : {"type" : ["string", "null"], "examples" : ["+46"]}, "domesticNumber" : {"type" : ["string", "null"], "examples" : ["0701234567"], "description" : "A potential leading 0 (zero), dash or hyphen, and white spaces will be cleaned from the input."}}, "required" : ["countryCode", "domesticNumber"]}}}}, "responses" : {"202" : {"description" : "Accepted", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/delegate\/lookup-person-name" : {"post" : {"operationId" : "psupsuIddelegatelookuppersonnamepost", "security" : [{"Bearer" : []}], "tags" : ["Delegate"], "summary" : "Lookup the name of a person", "description" : "The name of a person as retrieved from https:\/\/www.statenspersonadressregister.se\/.\r\n\r\nBefore adding a new delegate, this endpoint can be used to retrieve the name of the person for confirmation.", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"personKey" : {"type" : "string", "examples" : ["199403086854"], "pattern" : "^(19|20)[0-9]{6}[0-9]{4}$"}}, "required" : ["personKey"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"correspondenceName" : {"type" : "string", "examples" : ["John Doe"]}, "firstName" : {"type" : "string", "examples" : ["John"]}, "lastName" : {"type" : "string", "examples" : ["Doe"]}}, "required" : ["firstName", "lastName", "correspondenceName"]}}}}}}}, "\/psu\/{psuId}\/delegate\/{delegateId}\/client-settings" : {"get" : {"operationId" : "psupsuIddelegatedelegateIdclientsettingsget", "security" : [{"Bearer" : []}], "tags" : ["Delegate"], "summary" : "Get client settings for a delegate", "description" : "Client settings is an arbitrary json object that the clients can use to store settings for a delegate over different devices.", "parameters" : [{"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"settings" : {"oneOf" : [{"title" : "object", "type" : "object", "properties" : {}}]}}, "required" : ["settings"]}, "examples" : {"example" : {"description" : "", "summary" : "", "value" : {"settings" : {"darkMode" : true, "showBanner" : false}}}}}}}}}, "put" : {"operationId" : "psupsuIddelegatedelegateIdclientsettingsput", "security" : [{"Bearer" : []}], "tags" : ["Delegate"], "summary" : "Update client setting for a delegate", "description" : "Client settings is an arbitrary json object that can be used to store settings for a delegate over different devices. Ex. whether to show a banner, and switch between dark and light mode", "parameters" : [{"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"settings" : {"oneOf" : [{"title" : "object", "type" : "object", "properties" : {}}]}}, "required" : ["settings"]}, "examples" : {"example" : {"description" : "", "summary" : "", "value" : {"settings" : {"darkMode" : true, "showBanner" : false}}}}}}}, "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/card" : {"get" : {"operationId" : "psupsuIdcardget", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "List cards", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"capabilities" : {"type" : "array", "items" : {"type" : "string", "examples" : ["activate"], "enum" : ["activate", "pause", "replacePan", "credit", "readSecuritySettings", "updateSecuritySettings", "setPin", "viewPanDetails", "notificationSettings", "viewPin", "reissueCard"]}}, "cardContextType" : {"type" : "string", "examples" : ["debit"], "enum" : ["debit", "credit"], "description" : "**Note!** New cardContextTypes are created upon request by the tenant and must be supported by the clients before delivery to production."}, "cardHolderName" : {"type" : "string", "examples" : ["Åsa Mattsson"]}, "cardId" : {"type" : "string", "examples" : ["46d83b79-27d4-4039-95ad-6ba25c1627ce"], "format" : "uuid"}, "cardNumber" : {"type" : ["string", "null"], "examples" : ["537509******0997"]}, "cardProgram" : {"type" : "string", "examples" : ["SVEA_Debit_SveaBank"], "description" : "**Note!** New cardPrograms are created upon request by the tenant and must be supported by the clients before delivery to production."}, "organizationName" : {"type" : ["string", "null"], "examples" : ["Svea Bank AB"]}, "sequenceNumber" : {"type" : "string", "examples" : ["002"]}, "status" : {"type" : "string", "examples" : ["Active"], "enum" : ["Active", "Inactive", "Paused", "Terminated"]}, "validFrom" : {"type" : "string", "examples" : ["2019-05-01"], "format" : "date"}, "validTo" : {"type" : "string", "examples" : ["2022-06-30"], "format" : "date"}}, "required" : ["capabilities", "cardHolderName", "cardId", "cardNumber", "cardProgram", "cardContextType", "organizationName", "sequenceNumber", "status", "validFrom", "validTo"]}}}}}}}}, "\/psu\/{psuId}\/card\/{cardId}" : {"get" : {"operationId" : "psupsuIdcardcardIdget", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "Get a single card", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"capabilities" : {"type" : "array", "items" : {"type" : "string", "examples" : ["activate"], "enum" : ["activate", "pause", "replacePan", "credit", "readSecuritySettings", "updateSecuritySettings", "setPin", "viewPanDetails", "notificationSettings", "viewPin", "reissueCard"]}}, "cardContext" : {"oneOf" : [{"title" : "debit", "type" : "object", "properties" : {"balance" : {"type" : "string", "examples" : ["56786.82"], "pattern" : "[0-9]{1,}\\.[0-9]{2}"}, "bankAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "bankAccountName" : {"type" : "string", "examples" : ["Transaktionskonto"]}, "bankAccountNumber" : {"type" : "string", "examples" : ["9586892"], "pattern" : "^[0-9]{1,20}$"}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$"}}, "required" : ["bankAccountId", "bankAccountName", "clearingNumber", "bankAccountNumber", "balance"]}, {"title" : "credit", "type" : "object", "properties" : {"creditAccruedInterest" : {"type" : "string", "examples" : ["0.00"], "pattern" : "[0-9]{1,}\\.[0-9]{2}"}, "creditAvailable" : {"type" : "string", "examples" : ["100.00"], "pattern" : "[0-9]{1,}\\.[0-9]{2}"}, "creditUsed" : {"type" : "string", "examples" : ["0.00"], "pattern" : "[0-9]{1,}\\.[0-9]{2}"}}, "required" : ["creditUsed", "creditAvailable", "creditAccruedInterest"]}]}, "cardContextType" : {"type" : "string", "examples" : ["debit"], "enum" : ["debit", "credit"], "description" : "**Note!** New cardContextTypes are created upon request by the tenant and must be supported by the clients before delivery to production."}, "cardHolderName" : {"type" : "string", "examples" : ["Åsa Mattsson"]}, "cardId" : {"type" : "string", "examples" : ["46d83b79-27d4-4039-95ad-6ba25c1627ce"], "format" : "uuid"}, "cardNumber" : {"type" : ["string", "null"], "examples" : ["537509******0997"]}, "cardProgram" : {"type" : "string", "examples" : ["SVEA_Debit_SveaBank"], "description" : "**Note!** New cardPrograms are created upon request by the tenant and must be supported by the clients before delivery to production."}, "creditInterestRate" : {"type" : ["string", "null"], "examples" : ["15.90"], "pattern" : "[0-9]{1,}\\.[0-9]{2}", "description" : "The interest rate for the credit. For debit cards this is the interest rate of the underlying bank account."}, "creditLimit" : {"type" : "string", "examples" : ["100000.00"], "pattern" : "[0-9]{1,}\\.[0-9]{2}", "description" : "The maximum credit amout. For debit cards this is the credit limit of the underlying bank account."}, "currency" : {"type" : "string", "examples" : ["SEK"]}, "organizationName" : {"type" : ["string", "null"], "examples" : ["Svea Bank AB"]}, "sequenceNumber" : {"type" : "string", "examples" : ["002"]}, "status" : {"type" : "string", "examples" : ["Active"], "enum" : ["Active", "Inactive", "Paused", "Terminated"]}, "validFrom" : {"type" : "string", "examples" : ["2019-05-01"], "format" : "date"}, "validTo" : {"type" : "string", "examples" : ["2022-06-30"], "format" : "date"}}, "required" : ["capabilities", "cardHolderName", "cardId", "cardNumber", "cardProgram", "cardContext", "cardContextType", "creditInterestRate", "creditLimit", "currency", "organizationName", "sequenceNumber", "status", "validFrom", "validTo"]}}}}}}}, "\/psu\/{psuId}\/card\/{cardId}\/authorization" : {"get" : {"operationId" : "psupsuIdcardcardIdauthorizationget", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "List authorizations", "description" : "An authorization is a pending transfer of money, also known as reserved amount. An authorization can either go through and become a [**transaction**](psupsuIdcardcardIdtransactionget) or be withdrawn.", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/cardauthorizationsPageSize"}, {"$ref" : "#\/components\/parameters\/page"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["1267.85"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$", "description" : "The amount that the card's underlying account is debited or credited. Specified in the underlying accounts currency."}, "authorizationId" : {"type" : "string", "examples" : ["1"]}, "creditorCity" : {"type" : ["string", "null"], "examples" : ["g.co\/helppay#"]}, "creditorCountryCode" : {"type" : ["string", "null"], "examples" : ["SE"], "pattern" : "[A-Z]{2}", "description" : "Country code (ISO 3166-1 alpha-2)"}, "creditorName" : {"type" : "string", "examples" : ["GOOGLE *SERVICES"]}, "currency" : {"type" : "string", "examples" : ["SEK"], "description" : "The card's underlying accounts currency."}, "status" : {"type" : "string", "examples" : ["P"]}, "transactionAmount" : {"type" : "string", "examples" : ["100.00"], "pattern" : "[0-9]{1,}\\.[0-9]{2}", "description" : "The amount given in the transaction currency."}, "transactionCurrency" : {"type" : ["string", "null"], "examples" : ["GBP"], "description" : "The currency in which the transaction was initiated."}, "transactionTime" : {"type" : "string", "examples" : ["2018-12-28T15:31:25Z"], "format" : "date-time"}}, "required" : ["amount", "currency", "transactionTime", "transactionAmount", "transactionCurrency", "creditorName", "creditorCity", "creditorCountryCode", "authorizationId", "status"]}}}}}}}}, "\/psu\/{psuId}\/card\/{cardId}\/transaction" : {"get" : {"operationId" : "psupsuIdcardcardIdtransactionget", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "List transactions", "description" : "A card transactions is a successful card payment, a completed [**authorization**](\/operations\/psupsuIdcardcardIdauthorizationget). This includes refunds.", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/cardtransactionsPageSize"}, {"$ref" : "#\/components\/parameters\/page"}, {"$ref" : "#\/components\/parameters\/from"}, {"$ref" : "#\/components\/parameters\/to"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["1267.85"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$", "description" : "The amount that the card's underlying account is debited or credited. Specified in the underlying accounts currency."}, "creditorCity" : {"type" : ["string", "null"], "examples" : ["g.co\/helppay#"]}, "creditorCountryCode" : {"type" : ["string", "null"], "examples" : ["SE"], "pattern" : "[A-Z]{2}", "description" : "Country code (ISO 3166-1 alpha-2)"}, "creditorName" : {"type" : "string", "examples" : ["GOOGLE *SERVICES"]}, "currency" : {"type" : "string", "examples" : ["SEK"], "description" : "The card's underlying accounts currency."}, "status" : {"type" : "string", "examples" : ["R"]}, "transactionAmount" : {"type" : "string", "examples" : ["100.00"], "pattern" : "[0-9]{1,}\\.[0-9]{2}", "description" : "The amount given in the transaction currency."}, "transactionCurrency" : {"type" : ["string", "null"], "examples" : ["GBP"], "description" : "The currency in which the transaction was initiated."}, "transactionId" : {"type" : "string", "examples" : ["1"]}, "transactionTime" : {"type" : "string", "examples" : ["2018-12-28T15:31:25Z"], "format" : "date-time"}}, "required" : ["amount", "currency", "transactionTime", "transactionAmount", "transactionCurrency", "creditorName", "creditorCity", "creditorCountryCode", "transactionId", "status"]}}}}}}}}, "\/psu\/{psuId}\/card\/{cardId}\/activate" : {"post" : {"operationId" : "psupsuIdcardcardIdactivatepost", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "Activate card", "description" : "Activates the given card. Please note that the user\r\n        needs to set a PIN before the card can be activated for the first time.\r\n        If a card has been paused it can be re-activated using this operation.\r\n        See the documentation for the [Get set pin widget\r\n        parameters](\/operations\/psupsuIdcardcardIdpciwidgetparamssetpinget)\r\n        endpoint or the [Cards](https:\/\/baasdeveloperdemo.svea.com\/resources\/cards) developer resource for\r\n        details.", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/card\/{cardId}\/pause" : {"post" : {"operationId" : "psupsuIdcardcardIdpausepost", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "Pause card", "description" : "Pauses the given card. A paused card cannot be used to make\r\n        transactions. Paused cards can be activated again by calling [Activate\r\n        card](\/operations\/psupsuIdcardcardIdactivatepost).\r\n        Note that a paused card cannot be replaced; it needs to be re-activated\r\n        first. See the [Cards](https:\/\/baasdeveloperdemo.svea.com\/resources\/cards) developer resource for\r\n        details.", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/card\/{cardId}\/replace" : {"post" : {"operationId" : "psupsuIdcardcardIdreplacepost", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "Replace card", "description" : "Terminates the lost\/stolen card and replaces it with a new one.", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"reason" : {"type" : "string", "examples" : ["lost"], "enum" : ["lost", "stolen"]}}, "required" : ["reason"]}}}}, "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/card\/{cardId}\/security-settings" : {"get" : {"operationId" : "psupsuIdcardcardIdsecuritysettingsget", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "Get security settings", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"contactless" : {"type" : "boolean", "examples" : [true]}, "eCommerce" : {"type" : "boolean", "examples" : [true]}, "foreignTransactions" : {"type" : "boolean", "examples" : [true]}}, "required" : ["contactless", "eCommerce", "foreignTransactions"]}}}}}}, "put" : {"operationId" : "psupsuIdcardcardIdsecuritysettingsput", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "Update security settings", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"contactless" : {"type" : "boolean", "examples" : [true]}, "eCommerce" : {"type" : "boolean", "examples" : [true]}, "foreignTransactions" : {"type" : "boolean", "examples" : [true]}}, "required" : ["contactless", "eCommerce", "foreignTransactions"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"contactless" : {"type" : "boolean", "examples" : [true]}, "eCommerce" : {"type" : "boolean", "examples" : [true]}, "foreignTransactions" : {"type" : "boolean", "examples" : [true]}}, "required" : ["contactless", "eCommerce", "foreignTransactions"]}}}}}}}, "\/psu\/{psuId}\/card\/{cardId}\/notification-settings" : {"get" : {"operationId" : "psupsuIdcardcardIdnotificationsettingsget", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "Get notification settings", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"exchangeRate" : {"type" : "boolean", "examples" : [true]}}, "required" : ["exchangeRate"]}}}}}}, "put" : {"operationId" : "psupsuIdcardcardIdnotificationsettingsput", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "Update notification settings", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"exchangeRate" : {"type" : "boolean", "examples" : [true]}}, "required" : ["exchangeRate"]}}}}, "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/card\/{cardId}\/pci\/widget-params\/set-pin" : {"get" : {"operationId" : "psupsuIdcardcardIdpciwidgetparamssetpinget", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "Get set pin widget parameters", "description" : "This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request.\r\n        The response of the [**Verify**](\/operations\/signverifypost) request is a HTTP `200 Ok` response with the set pin widget parameters.\r\n\r\nPlease see this tutorial for details (steps 2 and 3 does not apply since you will get them from this endpoint): https:\/\/www.marqeta.com\/docs\/developer-guides\/using-activate-card-and-set-pin-widgets#_tutorial", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"applicationId" : {"type" : "string", "examples" : ["svea_sandbox_api_consumer"]}, "cardToken" : {"type" : "string", "examples" : ["1a51e724-fad6-493d-b0d9-09ba1f756a51"], "format" : "uuid"}, "oneTimeToken" : {"type" : "string", "examples" : ["e0b89ae0-ec28-4788-8a9d-07d879a28552"], "format" : "uuid"}, "userToken" : {"type" : "string", "examples" : ["bb64b7c8-f5af-4d3d-af8f-1ecb307ee649"], "format" : "uuid"}}, "required" : ["applicationId", "userToken", "cardToken", "oneTimeToken"]}}}}}}}, "\/psu\/{psuId}\/card\/{cardId}\/pci\/widget-params\/show-details" : {"get" : {"operationId" : "psupsuIdcardcardIdpciwidgetparamsshowdetailsget", "security" : [{"Bearer" : []}], "tags" : ["Card"], "summary" : "Get show details widget parameters", "description" : "This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request.\r\n        The response of the [**Verify**](\/operations\/signverifypost) request is a HTTP `200 Ok` response with the client access token needed for showing full PAN details.\r\n\r\nPlease see this tutorial for details (step 6 does not apply since you will get it from this endpoint): https:\/\/www.marqeta.com\/docs\/developer-guides\/using-marqeta-js#_tutorial", "parameters" : [{"$ref" : "#\/components\/parameters\/cardId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"clientAccessToken" : {"type" : "string", "examples" : ["eyJ0b2tlbiI6ICJhMmY4Nzc2ZS0yNWNhLTQwMTAtYjg3ZS0wNWUwZThiZGUyY2ImYXBwbGljYXRpb25fdG9rZW49c3ZlYV9zYW5kYm94X2FwaV9jb25zdW1lciIsICJhcHBsaWNhdGlvbiI6IHsidG9rZW4iOiJzdmVhX3NhbmRib3hfYXBpX2NvbnN1bWVyIiwiYWN0aXZlIjp0cnVlLCJjbGllbnRfYXBpX2Jhc2VfdXJsIjoiaHR0cHM6Ly93aWRnZXRzLXNhbmRib3gubWFycWV0YS5jb20vY2xpZW50L2FwaS92MSIsImFzc2V0c191cmwiOiJodHRwczovL3dpZGdldHMtc2FuZGJveC5tYXJxZXRhLmNvbS9jbGllbnQvYXNzZXRzLzEuMC4wIiwiY2xpZW50dG9rZW5hcHBsaWNhdGlvbl9pZCI6IjYyNjMxZDkyZTRiMGI1MzQ3NTkwMzc5OCJ9LCAiYXBwbGljYXRpb25fdG9rZW4iOiBudWxsLCAiZXhwaXJlcyI6ICIyMDIyLTA2LTA3VDEzOjM1OjI4KzAwMDAiLCAiY2FyZF90b2tlbiI6ICI0YjUyNzdjMS01MGNjLTRlYWUtYWRkZC1jMjg3NDRhYzI5MGYiLCAiYWNjZXNzZWQiOiBudWxsLCAiY2xpZW50dG9rZW5faWQiOiAiNjI5ZjUyZjRlNGIwYjUzNDc1OTQyNWUzIiwgImNyZWF0ZWQiOiAiMjAyMi0wNi0wN1QxMzozMDoyOCswMDAwIn0="]}}, "required" : ["clientAccessToken"]}}}}}}}, "\/psu\/{psuId}\/delegate\/{delegateId}\/inbox-message\/number-of-unread" : {"get" : {"operationId" : "psupsuIddelegatedelegateIdinboxmessagenumberofunreadget", "security" : [{"Bearer" : []}], "tags" : ["Inbox"], "summary" : "Get number of unread messages", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}, {"$ref" : "#\/components\/parameters\/delegateId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"numberOfUnread" : {"type" : "integer", "examples" : [3]}}, "required" : ["numberOfUnread"]}}}}}}}, "\/psu\/{psuId}\/delegate\/{delegateId}\/inbox-message" : {"get" : {"operationId" : "psupsuIddelegatedelegateIdinboxmessageget", "security" : [{"Bearer" : []}], "tags" : ["Inbox"], "summary" : "List messages", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}, {"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/from"}, {"$ref" : "#\/components\/parameters\/to"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"attachments" : {"type" : "array", "items" : {"type" : "object", "properties" : {"attachmentId" : {"type" : "string", "examples" : ["2341cbf9-3f9e-4762-8599-866e5ee15ee0"], "format" : "uuid"}, "availableUntil" : {"type" : "string", "examples" : ["2020-01-01T10:00:00Z"], "format" : "date", "description" : "The point in time when the file is removed from storage"}, "contentType" : {"type" : "string", "examples" : ["application\/pdf"], "description" : "Depends on file type"}, "filename" : {"type" : "string", "examples" : ["document.pdf"]}, "isAvailable" : {"type" : "boolean", "examples" : [true], "description" : "Whether or not availableUntil is in the future, asking for this resource when this value is false will result in a 404"}}, "required" : ["attachmentId", "availableUntil", "contentType", "filename", "isAvailable"]}}, "body" : {"type" : "string", "examples" : ["Here is your quarterly report"], "format" : "markdown", "description" : "This field contains a markdown formatted string."}, "header1" : {"type" : "string", "examples" : ["Yearly Report"]}, "header2" : {"type" : "string", "examples" : ["Q3 2019"]}, "logotypeUrl" : {"type" : "string", "examples" : ["http:\/\/someurl.com"]}, "messageContext" : {"oneOf" : [{"$ref" : "#\/components\/schemas\/bankMessage"}, {"$ref" : "#\/components\/schemas\/annualStatement"}, {"$ref" : "#\/components\/schemas\/incomingEinvoice"}, {"$ref" : "#\/components\/schemas\/incomingCreditNotification"}, {"$ref" : "#\/components\/schemas\/incomingAutogiroNotification"}, {"$ref" : "#\/components\/schemas\/incomingEDocument"}], "description" : "**Note!** New values might be added at any time and unknown values should be handled as the value `null`"}, "messageContextType" : {"type" : "string", "examples" : ["bankMessage"], "enum" : ["bankMessage", "annualStatement", "incomingEinvoice", "incomingCreditNotification", "incomingAutogiroNotification", "incomingEDocument"], "description" : "`bankMessage` and `annualStatement` does not have a context and therefor `messageContext` will be `null`"}, "messageId" : {"type" : "string", "examples" : ["2341cbf9-3f9e-4762-8599-866e5ee15ee0"], "format" : "uuid"}, "timeRead" : {"type" : ["string", "null"], "examples" : ["2019-01-01T16:20:00Z"], "format" : "date-time"}, "timeSent" : {"type" : "string", "examples" : ["2019-01-01T16:20:00Z"], "format" : "date-time"}}, "required" : ["attachments", "body", "header1", "header2", "logotypeUrl", "messageContext", "messageContextType", "messageId", "timeRead", "timeSent"]}}}}}}}}, "\/psu\/{psuId}\/delegate\/{delegateId}\/inbox-message\/{messageId}" : {"get" : {"operationId" : "psupsuIddelegatedelegateIdinboxmessagemessageIdget", "security" : [{"Bearer" : []}], "tags" : ["Inbox"], "summary" : "Get a single message", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}, {"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/messageId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"attachments" : {"type" : "array", "items" : {"type" : "object", "properties" : {"attachmentId" : {"type" : "string", "examples" : ["2341cbf9-3f9e-4762-8599-866e5ee15ee0"], "format" : "uuid"}, "availableUntil" : {"type" : "string", "examples" : ["2020-01-01T10:00:00Z"], "format" : "date", "description" : "The point in time when the file is removed from storage"}, "contentType" : {"type" : "string", "examples" : ["application\/pdf"], "description" : "Depends on file type"}, "filename" : {"type" : "string", "examples" : ["document.pdf"]}, "isAvailable" : {"type" : "boolean", "examples" : [true], "description" : "Whether or not availableUntil is in the future, asking for this resource when this value is false will result in a 404"}}, "required" : ["attachmentId", "availableUntil", "contentType", "filename", "isAvailable"]}}, "body" : {"type" : "string", "examples" : ["Here is your quarterly report"], "format" : "markdown", "description" : "This field contains a markdown formatted string."}, "header1" : {"type" : "string", "examples" : ["Yearly Report"]}, "header2" : {"type" : "string", "examples" : ["Q3 2019"]}, "logotypeUrl" : {"type" : "string", "examples" : ["http:\/\/someurl.com"]}, "messageContext" : {"oneOf" : [{"$ref" : "#\/components\/schemas\/bankMessage"}, {"$ref" : "#\/components\/schemas\/annualStatement"}, {"$ref" : "#\/components\/schemas\/incomingEinvoice"}, {"$ref" : "#\/components\/schemas\/incomingCreditNotification"}, {"$ref" : "#\/components\/schemas\/incomingAutogiroNotification"}, {"$ref" : "#\/components\/schemas\/incomingEDocument"}], "description" : "**Note!** New values might be added at any time and unknown values should be handled as the value `null`"}, "messageContextType" : {"type" : "string", "examples" : ["bankMessage"], "enum" : ["bankMessage", "annualStatement", "incomingEinvoice", "incomingCreditNotification", "incomingAutogiroNotification", "incomingEDocument"], "description" : "`bankMessage` and `annualStatement` does not have a context and therefor `messageContext` will be `null`"}, "messageId" : {"type" : "string", "examples" : ["2341cbf9-3f9e-4762-8599-866e5ee15ee0"], "format" : "uuid"}, "timeRead" : {"type" : ["string", "null"], "examples" : ["2019-01-01T16:20:00Z"], "format" : "date-time"}, "timeSent" : {"type" : "string", "examples" : ["2019-01-01T16:20:00Z"], "format" : "date-time"}}, "required" : ["attachments", "body", "header1", "header2", "logotypeUrl", "messageContext", "messageContextType", "messageId", "timeRead", "timeSent"]}}}}}}, "delete" : {"operationId" : "psupsuIddelegatedelegateIdinboxmessagemessageIddelete", "security" : [{"Bearer" : []}], "tags" : ["Inbox"], "summary" : "Delete message", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}, {"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/messageId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/delegate\/{delegateId}\/inbox-message\/{messageId}\/mark-as-read" : {"post" : {"operationId" : "psupsuIddelegatedelegateIdinboxmessagemessageIdmarkasreadpost", "security" : [{"Bearer" : []}], "tags" : ["Inbox"], "summary" : "Mark message as read", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}, {"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/messageId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/delegate\/{delegateId}\/inbox-message\/{messageId}\/attachment\/{attachmentId}" : {"get" : {"operationId" : "psupsuIddelegatedelegateIdinboxmessagemessageIdattachmentattachmentIdget", "security" : [{"Bearer" : []}], "tags" : ["Inbox"], "summary" : "Get attachment", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}, {"$ref" : "#\/components\/parameters\/delegateId"}, {"$ref" : "#\/components\/parameters\/messageId"}, {"$ref" : "#\/components\/parameters\/attachmentId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}, "Content-Disposition" : {"schema" : {"type" : "string"}, "example" : "Contains 'attachment;filename=X' where X is the name of the file attachment."}, "Content-Description" : {"schema" : {"type" : "string"}, "example" : "File Transfer"}, "Content-Transfer-Encoding" : {"schema" : {"type" : "string"}, "example" : "binary"}}, "content" : {"depends on file type (ex application\/pdf)" : {"schema" : {"type" : "string", "format" : "binary"}}}}}}}, "\/psu\/{psuId}\/autogiro\/consent" : {"get" : {"operationId" : "psupsuIdautogiroconsentget", "security" : [{"Bearer" : []}], "tags" : ["Autogiro"], "summary" : "Get autogiro consents", "description" : "Returns all autogiro consents registered for the psu", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"consentId" : {"type" : "string", "examples" : ["4712"]}, "consentStatus" : {"type" : "string", "examples" : ["approved"], "enum" : ["approved", "approvedUnderInquiry", "underInquiry", "preliminary", "expired", "cancelled", "rejected"]}, "creditor" : {"type" : "object", "properties" : {"bankGiroNumber" : {"type" : "string", "examples" : ["102-5592"]}, "name" : {"type" : "string", "examples" : ["Dream On Inkasso AB"]}, "organizationNumber" : {"type" : "string", "examples" : ["556688-8263"]}, "shortName" : {"type" : "string", "examples" : ["Dream On"]}}, "required" : ["bankGiroNumber", "name", "organizationNumber", "shortName"]}, "debtor" : {"type" : "object", "properties" : {"accountNumber" : {"type" : "string", "examples" : ["6743687"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "payerNumber" : {"type" : "string", "examples" : ["456789"]}}, "required" : ["clearingNumber", "accountNumber", "payerNumber"]}}, "required" : ["consentId", "consentStatus", "creditor", "debtor"]}}}}}}}}, "\/psu\/{psuId}\/bank-account" : {"get" : {"operationId" : "psupsuIdbankaccountget", "security" : [{"Bearer" : []}], "tags" : ["Bank Account"], "summary" : "List bank accounts", "description" : "List all bank accounts that the PSU has access to. Read more about bank accounts in the [**Glossary**](https:\/\/baasdeveloperdemo.svea.com\/resources\/glossary#bank-account)", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"balance" : {"type" : "object", "properties" : {"available" : {"type" : "string", "examples" : ["107872.99"], "description" : "Available balance at bank account, including authorizations"}, "current" : {"type" : "string", "examples" : ["107872.99"], "description" : "Current balance at bank account, excluding authorizations"}, "opening" : {"type" : "string", "examples" : ["107872.99"], "description" : "Balance at the beginning of the current banking day"}}, "required" : ["available", "current", "opening"]}, "bankAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "bankAccountNumber" : {"type" : "string", "examples" : ["3065548"]}, "bankAccountTypeClass" : {"type" : "string", "examples" : ["transactionAccount"], "enum" : ["transactionAccount", "savingsAccount", "loanAccount", "superAccount", "escrowAccount", "creditAccount", "unknown"], "description" : "BankAccountTypeClasses are unique per tenant and can be used for logic in the client.\r\n\r\n**Note!** New bankAccountTypeClasses are created upon request by the tenant and must be supported in the clients before delivery to production."}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"], "description" : "Human readable name of the bankAccountType"}, "bankGiroNumbers" : {"type" : "array", "items" : {"type" : "string", "maxLength" : 9, "minLength" : 8}}, "bic" : {"type" : "string", "examples" : ["SVEASESS"]}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : ["payToBGPG"], "enum" : ["payToBGPG", "payToOwnAccount", "payToSwedishBankAccount", "deposit", "sendInternationalPayments", "connectToSwish"]}}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK"]}, "customName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"], "maxLength" : 100}, "iban" : {"type" : "string", "examples" : ["SE3296600000096698590276"]}, "overdraftLimit" : {"type" : ["string", "null"], "examples" : ["0.00"]}, "status" : {"type" : "string", "examples" : ["open"], "enum" : ["open", "blocked"], "description" : "**Note!** New values might be added at any time and it's up to the client how to handle unknown statuses."}}, "required" : ["bankAccountTypeClass", "bankAccountTypeName", "balance", "bankAccountNumber", "bic", "capabilities", "clearingNumber", "currency", "customName", "iban", "bankAccountId", "overdraftLimit", "status", "bankGiroNumbers"]}}}}}}}}, "\/psu\/{psuId}\/bank-account\/{bankAccountId}" : {"get" : {"operationId" : "psupsuIdbankaccountbankAccountIdget", "security" : [{"Bearer" : []}], "tags" : ["Bank Account"], "summary" : "Get a single bank account", "description" : "Returns a single bank account for the PSU. Read more about bank accounts in the [**Glossary**](https:\/\/baasdeveloperdemo.svea.com\/resources\/glossary#bank-account)", "parameters" : [{"$ref" : "#\/components\/parameters\/bankAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"balance" : {"type" : "object", "properties" : {"available" : {"type" : "string", "examples" : ["107872.99"], "description" : "Available balance at bank account, including authorizations"}, "current" : {"type" : "string", "examples" : ["107872.99"], "description" : "Current balance at bank account, excluding authorizations"}, "opening" : {"type" : "string", "examples" : ["107872.99"], "description" : "Balance at the beginning of the current banking day"}}, "required" : ["available", "current", "opening"]}, "bankAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "bankAccountNumber" : {"type" : "string", "examples" : ["3065548"]}, "bankAccountTypeClass" : {"type" : "string", "examples" : ["transactionAccount"], "enum" : ["transactionAccount", "savingsAccount", "loanAccount", "superAccount", "escrowAccount", "creditAccount", "unknown"], "description" : "BankAccountTypeClasses are unique per tenant and can be used for logic in the client.\r\n\r\n**Note!** New bankAccountTypeClasses are created upon request by the tenant and must be supported in the clients before delivery to production."}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"], "description" : "Human readable name of the bankAccountType"}, "bankGiroNumbers" : {"type" : "array", "items" : {"type" : "string", "maxLength" : 9, "minLength" : 8}}, "bic" : {"type" : "string", "examples" : ["SVEASESS"]}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : ["payToBGPG"], "enum" : ["payToBGPG", "payToOwnAccount", "payToSwedishBankAccount", "deposit", "sendInternationalPayments", "connectToSwish"]}}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK"]}, "customName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"], "maxLength" : 100}, "iban" : {"type" : "string", "examples" : ["SE3296600000096698590276"]}, "interestPayable" : {"type" : "object", "properties" : {"accrued" : {"type" : ["string", "null"], "examples" : ["282.10"]}, "lastDate" : {"type" : ["string", "null"], "examples" : ["2018-12-31"]}, "rate" : {"type" : ["string", "null"], "examples" : ["1.25"]}, "total" : {"type" : ["string", "null"], "examples" : ["-20.45"]}}, "required" : ["accrued", "lastDate", "rate", "total"]}, "interestReceivable" : {"type" : "object", "properties" : {"accrued" : {"type" : ["string", "null"], "examples" : ["0.00"]}, "lastDate" : {"type" : ["string", "null"], "examples" : ["2018-12-31"]}, "monthlyRate" : {"type" : ["string", "null"], "examples" : ["0.00"]}, "rate" : {"type" : ["string", "null"], "examples" : ["0.00"]}, "total" : {"type" : ["string", "null"], "examples" : ["0.00"]}}, "required" : ["accrued", "lastDate", "rate", "total", "monthlyRate"]}, "overdraftLimit" : {"type" : ["string", "null"], "examples" : ["0.00"]}, "status" : {"type" : "string", "examples" : ["open"], "enum" : ["open", "blocked"], "description" : "**Note!** New values might be added at any time and it's up to the client how to handle unknown statuses."}}, "required" : ["bankAccountTypeClass", "bankAccountTypeName", "balance", "bankAccountNumber", "bic", "capabilities", "clearingNumber", "currency", "customName", "iban", "bankAccountId", "overdraftLimit", "status", "bankGiroNumbers", "interestPayable", "interestReceivable"]}}}}}}}, "\/psu\/{psuId}\/bank-account\/{bankAccountId}\/custom-name" : {"put" : {"operationId" : "psupsuIdbankaccountbankAccountIdcustomnameput", "security" : [{"Bearer" : []}], "tags" : ["Bank Account"], "summary" : "Set a custom name for a bank account", "description" : "Set, update or remove the custom name for a bank account. The custom name is removed by setting custom name to 'null'. Read more about bank accounts in the [**Glossary**](https:\/\/baasdeveloperdemo.svea.com\/resources\/glossary#bank-account)", "parameters" : [{"$ref" : "#\/components\/parameters\/bankAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"customName" : {"type" : ["string", "null"], "examples" : ["A custom name"], "maxLength" : 100}}, "required" : ["customName"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"customName" : {"type" : ["string", "null"], "examples" : ["A custom name"], "maxLength" : 100}}, "required" : ["customName"]}}}}}}}, "\/psu\/{psuId}\/bank-account\/{bankAccountId}\/transaction" : {"get" : {"operationId" : "psupsuIdbankaccountbankAccountIdtransactionget", "security" : [{"Bearer" : []}], "tags" : ["Bank Account"], "summary" : "List bank account transactions", "description" : "List transactions on a single bank account for the PSU. Read more about bank accounts and transactions in the [**Glossary**](https:\/\/baasdeveloperdemo.svea.com\/resources\/glossary#bank-account). ", "parameters" : [{"$ref" : "#\/components\/parameters\/Accept"}, {"$ref" : "#\/components\/parameters\/Accept-Language"}, {"$ref" : "#\/components\/parameters\/accountTransactionFrom"}, {"$ref" : "#\/components\/parameters\/accountTransactionTo"}, {"$ref" : "#\/components\/parameters\/transactionsPageSize"}, {"$ref" : "#\/components\/parameters\/page"}, {"$ref" : "#\/components\/parameters\/bankAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}, "Content-Type" : {"schema" : {"type" : "string"}, "description" : "application\/json or text\/csv", "example" : "application\/json"}, "Content-Disposition" : {"schema" : {"type" : "string"}, "description" : "Used only with 'text\/csv", "example" : "attachment;filename=transactions.csv"}, "Content-Description" : {"schema" : {"type" : "string"}, "description" : "Used only with 'text\/csv'", "example" : "File Transfer"}, "Content-Transfer-Encoding" : {"schema" : {"type" : "string"}, "description" : "Used only with 'text\/csv'", "example" : "binary"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["123.00"]}, "balance" : {"type" : "string", "examples" : ["42123.00"]}, "currency" : {"type" : "string", "examples" : ["SEK"]}, "processingDateTime" : {"type" : "string", "examples" : ["2018-05-14T16:19:38Z"]}, "reference" : {"type" : "string", "examples" : ["Uttag"]}, "transactionId" : {"type" : "string", "examples" : ["2ac0c2e0-5b20-4906-ab33-fbca39607531"], "format" : "uuid"}, "transactionTypeName" : {"type" : ["string", "null"], "examples" : ["apiPayment"], "enum" : ["apiPayment", "bankGiroCreditTransaction", "cardTransaction", "swishDebitTransaction", "swishCreditTransaction", "swishReturnDebitTransaction", "swishReturnCreditTransaction", "swishCommerceDebitTransaction", "swishCommerceRefundCreditTransaction", "swedishBankAccountTransaction", "bankGiroTransaction", "plusGiroTransaction", "swedishBankAccountCreditTransaction", "bankGiroAliasCreditTransaction"], "description" : "`null` means calls to the details endpoint will not give additional data.\r\n\r\n`apiPayment` means a payment initiated through the api, but further details cannot be given until the details endpoint is called.\r\n\r\nThe others are the same as contextType in transaction details.\r\n\r\n**Note!** New values might be added at any time and unknown values should be handled as the value `null`."}, "valueDate" : {"type" : "string", "examples" : ["2018-05-14"]}, "vat" : {"type" : "string", "examples" : ["0.00"]}}, "required" : ["transactionId", "reference", "currency", "processingDateTime", "valueDate", "amount", "balance", "vat", "transactionTypeName"]}}}, "text\/csv" : {"schema" : {"type" : "string"}}}}}}}, "\/psu\/{psuId}\/bank-account\/{bankAccountId}\/transaction\/search" : {"get" : {"operationId" : "psupsuIdbankaccountbankAccountIdtransactionsearchget", "security" : [{"Bearer" : []}], "tags" : ["Bank Account"], "summary" : "Search bank account transactions", "description" : "Search transactions on a single bank account for the PSU. Read more about bank accounts and transactions in the [**Glossary**](https:\/\/baasdeveloperdemo.svea.com\/resources\/glossary#bank-account).\r\n\n\nIf you want to filter transactions by amount, use the `amountFrom` and `amountTo` query parameters.\r\nNote that these can be combined to yield a range of amounts, e.g. `?amountFrom=10.00&amountTo=15.00` yields all transactions with amounts between 10.00 and 15.00.\r\nSince these ranges are inclusive, you can also filter by an exact amount by setting them to the same amount, e.g. `?amountFrom=10.00&amounTo=10.00`.", "parameters" : [{"$ref" : "#\/components\/parameters\/Accept"}, {"$ref" : "#\/components\/parameters\/Accept-Language"}, {"$ref" : "#\/components\/parameters\/accountTransactionFrom"}, {"$ref" : "#\/components\/parameters\/accountTransactionTo"}, {"$ref" : "#\/components\/parameters\/transactionsPageSize"}, {"$ref" : "#\/components\/parameters\/page"}, {"$ref" : "#\/components\/parameters\/bankAccountId"}, {"$ref" : "#\/components\/parameters\/filterAmountFrom"}, {"$ref" : "#\/components\/parameters\/filterAmountTo"}, {"$ref" : "#\/components\/parameters\/filterDescription"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["123.00"]}, "currency" : {"type" : "string", "examples" : ["SEK"]}, "processingDateTime" : {"type" : "string", "examples" : ["2018-05-14T16:19:38Z"]}, "reference" : {"type" : "string", "examples" : ["Uttag"]}, "transactionId" : {"type" : "string", "examples" : ["2ac0c2e0-5b20-4906-ab33-fbca39607531"], "format" : "uuid"}, "transactionType" : {"type" : ["string", "null"], "examples" : ["apiPayment"], "enum" : ["apiPayment", "bankGiroCreditTransaction", "cardTransaction", "swishDebitTransaction", "swishCreditTransaction", "swishReturnDebitTransaction", "swishReturnCreditTransaction", "swishCommerceDebitTransaction", "swishCommerceRefundCreditTransaction", "swedishBankAccountTransaction", "bankGiroTransaction", "plusGiroTransaction", "swedishBankAccountCreditTransaction", "bankGiroAliasCreditTransaction"], "description" : "`null` means calls to the details endpoint will not give additional data.\r\n\r\n`apiPayment` means a payment initiated through the api, but further details cannot be given until the details endpoint is called.\r\n\r\nThe others are the same as contextType in transaction details.\r\n\r\n**Note!** New values might be added at any time and unknown values should be handled as the value `null`."}, "valueDate" : {"type" : "string", "examples" : ["2018-05-14"]}, "vat" : {"type" : "string", "examples" : ["0.00"]}}, "required" : ["transactionId", "reference", "currency", "processingDateTime", "valueDate", "amount", "vat", "transactionType"]}}}}}}}}, "\/psu\/{psuId}\/bank-account\/{bankAccountId}\/transaction\/{transactionId}" : {"get" : {"operationId" : "psupsuIdbankaccountbankAccountIdtransactiontransactionIdget", "security" : [{"Bearer" : []}], "tags" : ["Bank Account"], "summary" : "Get a single bank account transaction", "description" : "Get a single bank account transaction for the PSU. Read more about bank accounts and transactions in the [**Glossary**](https:\/\/baasdeveloperdemo.svea.com\/resources\/glossary#bank-account)", "parameters" : [{"$ref" : "#\/components\/parameters\/transactionId"}, {"$ref" : "#\/components\/parameters\/bankAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["123.00"]}, "balance" : {"type" : "string", "examples" : ["42123.00"]}, "currency" : {"type" : "string", "examples" : ["SEK"]}, "processingDateTime" : {"type" : "string", "examples" : ["2018-05-14T16:19:38Z"]}, "reference" : {"type" : "string", "examples" : ["Uttag"]}, "transactionContext" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"creditorBankAccountNumber" : {"type" : "string", "examples" : ["1239508"]}, "creditorClearingNumber" : {"type" : "string", "examples" : ["95083"]}, "creditorCustomName" : {"type" : ["string", "null"], "examples" : ["Tele2"], "maxLength" : 100}, "creditorDisplayName" : {"type" : "string", "examples" : ["Nordea"], "description" : "Receiving banks name"}, "creditorMessage" : {"type" : "string", "examples" : ["123123456"]}, "creditorName" : {"type" : "string", "examples" : ["Sven Svensson"], "maxLength" : 140, "description" : "Name of the intended recipient"}, "debtorMessage" : {"type" : ["string", "null"], "examples" : ["Just some text"]}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "signatories" : {"type" : "array", "items" : {"type" : "object", "properties" : {"name" : {"type" : "string"}}, "required" : ["name"]}}, "signedBy" : {"type" : ["string", "null"]}, "signedTime" : {"type" : ["string", "null"], "format" : "date"}}, "required" : ["debtorMessage", "externalPaymentReference", "signedTime", "signedBy", "signatories", "creditorBankAccountNumber", "creditorClearingNumber", "creditorCustomName", "creditorDisplayName", "creditorMessage", "creditorName"]}, {"title" : "ownBankAccount", "type" : "object", "properties" : {"creditorBankAccountNumber" : {"type" : "string", "examples" : ["1239508"]}, "creditorBankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"]}, "creditorClearingNumber" : {"type" : "string", "examples" : ["95083"]}, "creditorCustomName" : {"type" : ["string", "null"], "examples" : ["Tele2"], "maxLength" : 100}, "creditorMessage" : {"type" : ["string", "null"], "examples" : ["123123456"]}, "debtorMessage" : {"type" : ["string", "null"], "examples" : ["Just some text"]}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "signatories" : {"type" : "array", "items" : {"type" : "object", "properties" : {"name" : {"type" : "string"}}, "required" : ["name"]}}, "signedBy" : {"type" : ["string", "null"]}, "signedTime" : {"type" : ["string", "null"], "format" : "date"}}, "required" : ["debtorMessage", "externalPaymentReference", "signedTime", "signedBy", "signatories", "creditorBankAccountNumber", "creditorBankAccountTypeName", "creditorClearingNumber", "creditorCustomName", "creditorMessage"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"creditorBankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "creditorCustomName" : {"type" : ["string", "null"], "examples" : ["Tele2"], "maxLength" : 100}, "creditorDisplayName" : {"type" : "string", "examples" : ["Tele2"], "description" : "Organization associated with the BankGiroNumber"}, "creditorMessage" : {"type" : "string", "examples" : ["123456789"]}, "debtorMessage" : {"type" : ["string", "null"], "examples" : ["Just some text"]}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "signatories" : {"type" : "array", "items" : {"type" : "object", "properties" : {"name" : {"type" : "string"}}, "required" : ["name"]}}, "signedBy" : {"type" : ["string", "null"]}, "signedTime" : {"type" : ["string", "null"], "format" : "date"}}, "required" : ["debtorMessage", "externalPaymentReference", "signedTime", "signedBy", "signatories", "creditorBankGiroNumber", "creditorCustomName", "creditorDisplayName", "creditorMessage"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"creditorCustomName" : {"type" : ["string", "null"], "examples" : ["Tele2"], "maxLength" : 100}, "creditorDisplayName" : {"type" : "string", "examples" : ["Tele2"], "description" : "Organization associated with the PlusGiroNumber"}, "creditorMessage" : {"type" : "string", "examples" : ["123123456"]}, "creditorPlusGiroNumber" : {"type" : "string", "examples" : ["191950-6"], "pattern" : "^[0-9]{1,7}-?[0-9]$"}, "debtorMessage" : {"type" : ["string", "null"], "examples" : ["Just some text"]}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "signatories" : {"type" : "array", "items" : {"type" : "object", "properties" : {"name" : {"type" : "string"}}, "required" : ["name"]}}, "signedBy" : {"type" : ["string", "null"]}, "signedTime" : {"type" : ["string", "null"], "format" : "date"}}, "required" : ["debtorMessage", "externalPaymentReference", "signedTime", "signedBy", "signatories", "creditorCustomName", "creditorDisplayName", "creditorMessage", "creditorPlusGiroNumber"]}, {"title" : "iban", "type" : "object", "properties" : {"creditorAddressLine1" : {"type" : "string", "examples" : ["Street 1"]}, "creditorAddressLine2" : {"type" : ["string", "null"], "examples" : ["CO Someone"]}, "creditorBicNumber" : {"type" : ["string", "null"], "examples" : ["NDEASESS"], "minLength" : 8}, "creditorCity" : {"type" : "string", "examples" : ["Stockholm"]}, "creditorCountry" : {"type" : "string", "examples" : ["SE"]}, "creditorCounty" : {"type" : ["string", "null"], "examples" : ["Solna"]}, "creditorCustomName" : {"type" : ["string", "null"], "examples" : ["Tele2"], "maxLength" : 100}, "creditorDisplayName" : {"type" : "string", "examples" : ["Tele2"], "description" : "Name of the person or Organization that owns the account (according to the preregistered account)"}, "creditorIban" : {"type" : "string", "examples" : ["SE7280000810340009783242"], "pattern" : "[A-Za-z]{2}[0-9]{2}[A-Za-z0-9]{11,}", "minLength" : 15}, "creditorMessage" : {"type" : "string", "examples" : ["123123456"]}, "creditorZipCode" : {"type" : "string", "examples" : ["12345"]}, "debtorMessage" : {"type" : ["string", "null"], "examples" : ["Just some text"]}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "paymentCode" : {"type" : ["string", "null"], "examples" : ["101"], "enum" : ["101", "122", "130", "131", "140", "141", "142", "143", "150", "160", "161", "162", "163", "173", "200", "201", "202", "221", "223", "300", "301", "302", "303", "310", "321", "331", "401", "402", "403", "410", "411", "412", "413", "423", "430", "431", "440", "441", "442", "450", "451", "452", "460", "461", "462", "470", "473", "473", "510", "520", "540", "550", "551", "552", "553", "560", "600", "601", "602", "603", "620", "622", "631", "633", "670", "681", "683", "701", "701", "710", "712", "723", "723", "751", "793", "801", "801", "803", "803", "831", "831", "833", "833", "881", "881", "883", "883", "893", "900", "900", "902", "902", "910", "910", "912", "912", "940", "941", "999"], "maxLength" : 3, "minLength" : 3, "description" : "Required for International payments over 150 000SEK."}, "preregisteredAccountId" : {"type" : ["string", "null"], "examples" : ["69510de7-24ae-49b0-8e0d-f15578030722"], "format" : "uuid"}, "signatories" : {"type" : "array", "items" : {"type" : "object", "properties" : {"name" : {"type" : "string"}}, "required" : ["name"]}}, "signedBy" : {"type" : ["string", "null"]}, "signedTime" : {"type" : ["string", "null"], "format" : "date"}, "transactionAmount" : {"type" : "string", "examples" : ["100.00"], "description" : "The amount given in the transaction currency"}, "transactionCurrency" : {"type" : "string", "examples" : ["SEK"], "description" : "The currency in which the transaction was initiated"}}, "required" : ["debtorMessage", "externalPaymentReference", "signedTime", "signedBy", "signatories", "preregisteredAccountId", "creditorMessage", "creditorCustomName", "creditorDisplayName", "creditorIban", "creditorBicNumber", "creditorAddressLine1", "creditorAddressLine2", "creditorZipCode", "creditorCity", "creditorCounty", "creditorCountry", "transactionCurrency", "transactionAmount", "paymentCode"]}, {"title" : "card", "type" : "object", "properties" : {"cardHolderName" : {"type" : "string", "examples" : ["John Doe"]}, "cardNumber" : {"type" : ["string", "null"], "examples" : ["537509******8559"]}, "creditorCity" : {"type" : ["string", "null"], "examples" : ["g.co\/helppay#"]}, "creditorCountryCode" : {"type" : ["string", "null"], "examples" : ["SE"], "pattern" : "[A-Z]{2}", "description" : "Country code (ISO 3166-1 alpha-2)"}, "creditorName" : {"type" : "string", "examples" : ["GOOGLE *SERVICES"]}, "transactionAmount" : {"type" : "string", "examples" : ["10.50"], "description" : "The amount given in the transaction currency"}, "transactionCurrency" : {"type" : ["string", "null"], "examples" : ["GBP"], "description" : "The currency in which the transaction was initiated"}}, "required" : ["creditorName", "creditorCity", "creditorCountryCode", "transactionCurrency", "transactionAmount", "cardHolderName", "cardNumber"]}, {"title" : "swishDebit", "type" : "object", "properties" : {"creditorName" : {"type" : "string", "examples" : ["Jane Doe"]}, "creditorSwishAlias" : {"type" : "string", "examples" : ["46701740671"]}, "debtorName" : {"type" : "string", "examples" : ["John Doe"]}, "debtorSwishAlias" : {"type" : "string", "examples" : ["46701740670"]}, "message" : {"type" : ["string", "null"], "examples" : ["Tack för lånet"]}, "transactionReference" : {"type" : "string", "examples" : ["6341913877498062"]}}, "required" : ["creditorName", "creditorSwishAlias", "debtorName", "debtorSwishAlias", "message", "transactionReference"]}, {"title" : "swishCredit", "type" : "object", "properties" : {"creditorName" : {"type" : "string", "examples" : ["Jane Doe"]}, "creditorSwishAlias" : {"type" : "string", "examples" : ["46701740671"]}, "debtorName" : {"type" : "string", "examples" : ["John Doe"]}, "debtorSwishAlias" : {"type" : "string", "examples" : ["46701740670"]}, "message" : {"type" : ["string", "null"], "examples" : ["Tack för lånet"]}, "transactionReference" : {"type" : "string", "examples" : ["6341913877498062"]}}, "required" : ["creditorName", "creditorSwishAlias", "debtorName", "debtorSwishAlias", "message", "transactionReference"]}, {"title" : "swishReturnDebit", "type" : "object", "properties" : {"creditorName" : {"type" : "string", "examples" : ["Jane Doe"]}, "creditorSwishAlias" : {"type" : "string", "examples" : ["46701740671"]}, "debtorName" : {"type" : "string", "examples" : ["John Doe"]}, "debtorSwishAlias" : {"type" : "string", "examples" : ["46701740670"]}, "message" : {"type" : ["string", "null"], "examples" : ["Tack för lånet"]}, "transactionReference" : {"type" : "string", "examples" : ["6341913877498062"]}}, "required" : ["creditorName", "creditorSwishAlias", "debtorName", "debtorSwishAlias", "message", "transactionReference"]}, {"title" : "swishReturnCredit", "type" : "object", "properties" : {"creditorName" : {"type" : "string", "examples" : ["Jane Doe"]}, "creditorSwishAlias" : {"type" : "string", "examples" : ["46701740671"]}, "debtorName" : {"type" : "string", "examples" : ["John Doe"]}, "debtorSwishAlias" : {"type" : "string", "examples" : ["46701740670"]}, "message" : {"type" : ["string", "null"], "examples" : ["Tack för lånet"]}, "transactionReference" : {"type" : "string", "examples" : ["6341913877498062"]}}, "required" : ["creditorName", "creditorSwishAlias", "debtorName", "debtorSwishAlias", "message", "transactionReference"]}, {"title" : "swishCommerceDebit", "type" : "object", "properties" : {"creditorName" : {"type" : "string", "examples" : ["Jane Doe"]}, "debtorName" : {"type" : "string", "examples" : ["John Doe"]}, "debtorSwishAlias" : {"type" : "string", "examples" : ["46701740670"]}, "message" : {"type" : ["string", "null"], "examples" : ["Tack för lånet"]}, "transactionReference" : {"type" : "string", "examples" : ["6341913877498062"]}}, "required" : ["creditorName", "debtorName", "debtorSwishAlias", "message", "transactionReference"]}, {"title" : "swishCommerceRefundCredit", "type" : "object", "properties" : {"creditorName" : {"type" : "string", "examples" : ["Jane Doe"]}, "creditorSwishAlias" : {"type" : "string", "examples" : ["46701740671"]}, "debtorName" : {"type" : "string", "examples" : ["John Doe"]}, "message" : {"type" : ["string", "null"], "examples" : ["Retur"]}, "transactionReference" : {"type" : "string", "examples" : ["6341913877498062"]}}, "required" : ["creditorName", "creditorSwishAlias", "debtorName", "message", "transactionReference"]}, {"title" : "bankGiroCredit", "type" : "object", "properties" : {"bankGiroTransactions" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["150.00"]}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK"]}}, "required" : ["currency", "amount"]}, "bgcSerialNumber" : {"type" : "string", "pattern" : "[0-9]{12}"}, "debtor" : {"type" : "object", "properties" : {"address" : {"type" : ["string", "null"]}, "bankGiroNumber" : {"type" : ["string", "null"], "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "city" : {"type" : ["string", "null"]}, "country" : {"type" : ["string", "null"]}, "countryCode" : {"type" : ["string", "null"]}, "name" : {"type" : ["string", "null"]}, "nameExtra" : {"type" : ["string", "null"], "description" : "Additional name information, e.g. C\/O"}, "organizationNumber" : {"type" : ["string", "null"]}, "zipCode" : {"type" : ["string", "null"]}}, "required" : ["bankGiroNumber", "name", "nameExtra", "address", "zipCode", "city", "country", "countryCode", "organizationNumber"]}, "deductionType" : {"type" : ["string", "null"], "enum" : ["completeDeductionNoRest", "partialDeductionWithRest", "finalDeductionWithPartialDeductionNoRest", "other"]}, "informationText" : {"type" : ["string", "null"], "description" : "Extra information from the debtor"}, "reference" : {"type" : "string", "maxLength" : 25}}, "required" : ["amount", "bgcSerialNumber", "reference", "informationText", "debtor", "deductionType"]}}, "creditorBankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "depositSerialNumber" : {"type" : "integer", "description" : "Unique per Bankgiro number and year"}}, "required" : ["creditorBankGiroNumber", "depositSerialNumber", "bankGiroTransactions"]}, {"title" : "instantCreditTransferCredit", "type" : "object", "properties" : {"debtorName" : {"type" : "string", "examples" : ["John Doe"]}}, "required" : ["debtorName"]}, {"title" : "swedishBankAccountCredit", "type" : "object", "properties" : {"creditorName" : {"type" : "string", "examples" : ["John Doe"]}, "debtorName" : {"type" : "string", "examples" : ["John Doe"]}, "endToEndId" : {"type" : "string", "examples" : ["11f33c1a6609429684cf2d2b684c4912"], "maxLength" : 35}, "message" : {"type" : ["string", "null"], "examples" : ["Rent"]}, "structuredRemittanceInfo" : {"type" : "array", "items" : {"type" : "object", "properties" : {"additionalInfo" : {"type" : "array", "items" : {"type" : "string", "examples" : ["Additional information"]}, "minItems" : 0, "maxItmes" : 3}, "amount" : {"type" : ["string", "null"], "examples" : ["150.00"]}, "code" : {"type" : "string", "examples" : ["SCOR"]}, "reference" : {"type" : "string", "examples" : ["100014489825"]}}, "required" : ["code", "reference", "amount", "additionalInfo"]}}, "ultimateCreditorName" : {"type" : ["string", "null"], "examples" : ["John Doe"]}, "ultimateDebtorName" : {"type" : ["string", "null"], "examples" : ["John Doe"]}}, "required" : ["endToEndId", "ultimateDebtorName", "debtorName", "ultimateCreditorName", "creditorName", "message", "structuredRemittanceInfo"]}, {"title" : "bankGiroAliasCredit", "type" : "object", "properties" : {"creditorBankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "creditorName" : {"type" : "string", "examples" : ["John Doe"]}, "debtorName" : {"type" : "string", "examples" : ["John Doe"]}, "endToEndId" : {"type" : "string", "examples" : ["11f33c1a6609429684cf2d2b684c4912"], "maxLength" : 35}, "message" : {"type" : ["string", "null"], "examples" : ["Rent"]}, "structuredRemittanceInfo" : {"type" : "array", "items" : {"type" : "object", "properties" : {"additionalInfo" : {"type" : "array", "items" : {"type" : "string", "examples" : ["Additional information"]}, "minItems" : 0, "maxItmes" : 3}, "amount" : {"type" : ["string", "null"], "examples" : ["150.00"]}, "code" : {"type" : "string", "examples" : ["SCOR"]}, "reference" : {"type" : "string", "examples" : ["100014489825"]}}, "required" : ["code", "reference", "amount", "additionalInfo"]}}, "ultimateCreditorName" : {"type" : ["string", "null"], "examples" : ["John Doe"]}, "ultimateDebtorName" : {"type" : ["string", "null"], "examples" : ["John Doe"]}}, "required" : ["creditorBankGiroNumber", "endToEndId", "ultimateDebtorName", "debtorName", "ultimateCreditorName", "creditorName", "message", "structuredRemittanceInfo"]}], "description" : "**Note!** If transactionContextType is `null` so is transactionContext"}, "transactionContextType" : {"type" : ["string", "null"], "examples" : ["bankGiro"], "enum" : ["swedishBankAccount", "ownBankAccount", "bankGiro", "bankGiroCredit", "plusGiro", "iban", "card", "swishDebit", "swishCredit", "swishReturnDebit", "swishReturnCredit", "swishCommerceDebit", "swishCommerceRefundCredit", "instantCreditTransferCredit", "swedishBankAccountCredit", "bankGiroAliasCredit"], "description" : "**Note!** New values might be added at any time and unknown values should be handled as the value `null`"}, "transactionId" : {"type" : "string", "examples" : ["2ac0c2e0-5b20-4906-ab33-fbca39607531"], "format" : "uuid"}, "valueDate" : {"type" : "string", "examples" : ["2018-05-14"]}, "vat" : {"type" : "string", "examples" : ["0.00"]}}, "required" : ["transactionId", "reference", "currency", "processingDateTime", "valueDate", "amount", "balance", "vat", "transactionContextType", "transactionContext"]}}}}}}}, "\/psu\/{psuId}\/bank-account\/{bankAccountId}\/card-authorization" : {"get" : {"operationId" : "psupsuIdbankaccountbankAccountIdcardauthorizationget", "security" : [{"Bearer" : []}], "tags" : ["Bank Account"], "summary" : "List bank account card authorizations", "description" : "List card authorizations on a single bank account for the PSU. Read more about bank accounts and authorizations in the [**Glossary**](https:\/\/baasdeveloperdemo.svea.com\/resources\/glossary#bank-account)", "parameters" : [{"$ref" : "#\/components\/parameters\/Accept"}, {"$ref" : "#\/components\/parameters\/Accept-Language"}, {"$ref" : "#\/components\/parameters\/authorizationsPageSize"}, {"$ref" : "#\/components\/parameters\/page"}, {"$ref" : "#\/components\/parameters\/bankAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}, "Content-Type" : {"schema" : {"type" : "string"}, "description" : "application\/json or text\/csv", "example" : "application\/json"}, "Content-Disposition" : {"schema" : {"type" : "string"}, "description" : "Used only with 'text\/csv'", "example" : "attachment;filename=cardAuthorizations.csv"}, "Content-Description" : {"schema" : {"type" : "string"}, "description" : "Used only with 'text\/csv'", "example" : "File Transfer"}, "Content-Transfer-Encoding" : {"schema" : {"type" : "string"}, "description" : "Used only with 'text\/csv'", "example" : "binary"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["10.50"]}, "authorizationId" : {"type" : "string", "examples" : ["12"]}, "creditorCity" : {"type" : ["string", "null"], "examples" : ["STOCKHOLM"]}, "creditorCountryCode" : {"type" : ["string", "null"], "examples" : ["SE"], "pattern" : "[A-Z]{2}", "description" : "Country code (ISO 3166-1 alpha-2)"}, "creditorName" : {"type" : "string", "examples" : ["ABC"]}, "currency" : {"type" : "string", "examples" : ["SEK"]}, "status" : {"type" : "string", "examples" : ["P"]}, "transactionAmount" : {"type" : "string", "examples" : ["10.50"], "description" : "The amount given in the transaction currency"}, "transactionCurrency" : {"type" : ["string", "null"], "examples" : ["SEK"], "description" : "The currency in which the transaction was initiated"}, "transactionTime" : {"type" : "string", "examples" : ["2018-12-28T15:31:25Z"], "format" : "date-time"}}, "required" : ["authorizationId", "amount", "currency", "transactionTime", "transactionAmount", "transactionCurrency", "creditorName", "creditorCity", "creditorCountryCode", "status"]}}}, "text\/csv" : {"schema" : {"type" : "string"}}}}}}}, "\/psu\/{psuId}\/bank-account\/{bankAccountId}\/reservation" : {"get" : {"operationId" : "psupsuIdbankaccountbankAccountIdreservationget", "security" : [{"Bearer" : []}], "tags" : ["Bank Account"], "summary" : "Get reservations for a single bank account", "description" : "Get reservations for a single bank account for the PSU. Read more about bank accounts in the [**Glossary**](https:\/\/baasdeveloperdemo.svea.com\/resources\/glossary#bank-account)", "parameters" : [{"$ref" : "#\/components\/parameters\/reservationPageSize"}, {"$ref" : "#\/components\/parameters\/reservationPage"}, {"$ref" : "#\/components\/parameters\/bankAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["145.00"], "description" : "The amount that the underlying account is debited or credited. Specified in the currency of the underlying account."}, "reservationContext" : {"oneOf" : [{"title" : "accountReservation", "type" : "object", "properties" : {"creditorMessage" : {"type" : "string", "examples" : ["A message"], "maxLength" : 50}, "debtorMessage" : {"type" : "string", "examples" : ["Description"], "maxLength" : 200}, "reservationId" : {"type" : "string", "examples" : ["719ffcce-7130-4847-a516-b177e9d5d861"], "format" : "uuid"}}, "required" : ["reservationId", "debtorMessage", "creditorMessage"]}, {"title" : "cardAuthorization", "type" : "object", "properties" : {"creditorCity" : {"type" : ["string", "null"], "examples" : ["g.co\/helppay#"]}, "creditorCountryCode" : {"type" : ["string", "null"], "examples" : ["SE"], "pattern" : "[A-Z]{2}", "description" : "Country code (ISO 3166-1 alpha-2)"}, "creditorName" : {"type" : "string", "examples" : ["GOOGLE *SERVICES"]}, "currency" : {"type" : "string", "examples" : ["SEK"], "description" : "The currency of the card's underlying account."}, "transactionAmount" : {"type" : "string", "examples" : ["100.00"], "pattern" : "[0-9]{1,}\\.[0-9]{2}", "description" : "The amount given in the transaction currency."}, "transactionCurrency" : {"type" : ["string", "null"], "examples" : ["GBP"], "description" : "The currency in which the transaction was initiated."}}, "required" : ["currency", "transactionAmount", "transactionCurrency", "creditorName", "creditorCity", "creditorCountryCode"]}]}, "reservationContextType" : {"type" : ["string", "null"], "examples" : ["accountReservation"], "enum" : ["accountReservation", "cardAuthorization"], "description" : "**Note!** New values might be added at any time and unknown values should be handled as the value `null`"}, "reservationDateTime" : {"type" : "string", "examples" : ["2018-12-28T15:31:25Z"], "format" : "date-time"}}, "required" : ["amount", "reservationDateTime", "reservationContextType", "reservationContext"]}}}}}}}}, "\/psu\/{psuId}\/bank-account\/{bankAccountId}\/report\/transaction-list" : {"get" : {"operationId" : "psupsuIdbankaccountbankAccountIdreporttransactionlistget", "security" : [{"Bearer" : []}], "tags" : ["Reports"], "summary" : "List transactions", "description" : "Max interval: 3 months", "parameters" : [{"$ref" : "#\/components\/parameters\/from"}, {"$ref" : "#\/components\/parameters\/to"}, {"$ref" : "#\/components\/parameters\/ReportAcceptHeaderSchema"}, {"$ref" : "#\/components\/parameters\/ReportAccept-LanguageHeaderSchema"}, {"$ref" : "#\/components\/parameters\/bankAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Disposition" : {"schema" : {"type" : "string"}, "example" : "attachment;filename=Transaktioner_2018-03-31.csv"}}, "content" : {"text\/csv" : {"schema" : {"type" : "string"}}}}}}}, "\/psu\/{psuId}\/bank-account\/{bankAccountId}\/report\/payment-list" : {"get" : {"operationId" : "psupsuIdbankaccountbankAccountIdreportpaymentlistget", "security" : [{"Bearer" : []}], "tags" : ["Reports"], "summary" : "List payments", "description" : "Max interval: 3 months", "parameters" : [{"$ref" : "#\/components\/parameters\/from"}, {"$ref" : "#\/components\/parameters\/to"}, {"$ref" : "#\/components\/parameters\/ReportAcceptHeaderSchema"}, {"$ref" : "#\/components\/parameters\/ReportAccept-LanguageHeaderSchema"}, {"$ref" : "#\/components\/parameters\/bankAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Disposition" : {"schema" : {"type" : "string"}, "example" : "attachment;filename=Betalningar_2018-03-31.csv"}}, "content" : {"text\/csv" : {"schema" : {"type" : "string"}}}}}}}, "\/psu\/{psuId}\/loan-account" : {"get" : {"operationId" : "psupsuIdloanaccountget", "security" : [{"Bearer" : []}], "tags" : ["Loan Account"], "summary" : "List loan accounts", "description" : "List all loan accounts that the PSU has access to. Read more about loan accounts in the [**Glossary**](https:\/\/baasdeveloperdemo.svea.com\/resources\/glossary#loan-account)", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"balance" : {"type" : "object", "properties" : {"available" : {"type" : "string", "examples" : ["0.00"], "description" : "Available balance at loan account, including authorizations"}, "current" : {"type" : "string", "examples" : ["-107872.00"], "description" : "Current balance at bank account, excluding authorizations"}, "opening" : {"type" : "string", "examples" : ["-107872.00"], "description" : "Balance at the beginning of the current banking day"}}, "required" : ["available", "current", "opening"]}, "bankAccountTypeClass" : {"type" : "string", "examples" : ["loanAccount"], "description" : "BankAccountTypeClasses are unique per tenant and can be used for logic in the client.\r\n\r\n**Note!** New values might be added at any time and the client should have a default case for handling unknown bankAccountTypeClasses."}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Företagslån Plus"]}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : [""]}}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK"]}, "displayName" : {"type" : "string", "examples" : ["401-9568165-5544-43"]}, "loanAccountId" : {"type" : "string", "examples" : ["cc594e2a-aa54-4a01-82ca-88d539751c4a"], "format" : "uuid"}, "overdraftLimit" : {"type" : "string", "examples" : ["250000.00"]}, "status" : {"type" : "string", "examples" : ["open"], "enum" : ["open", "blocked"], "description" : "**Note!** New values might be added at any time and it's up to the client how to handle unknown statuses."}}, "required" : ["bankAccountTypeClass", "bankAccountTypeName", "balance", "capabilities", "currency", "displayName", "loanAccountId", "overdraftLimit", "status"]}}}}}}}}, "\/psu\/{psuId}\/loan-account\/{loanAccountId}" : {"get" : {"operationId" : "psupsuIdloanaccountloanAccountIdget", "security" : [{"Bearer" : []}], "tags" : ["Loan Account"], "summary" : "Get a single loan account", "description" : "Get a specific loan accounts for the PSU. Read more about loan accounts in the [**Glossary**](https:\/\/baasdeveloperdemo.svea.com\/resources\/glossary#loan-account)", "parameters" : [{"$ref" : "#\/components\/parameters\/loanAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"balance" : {"type" : "object", "properties" : {"available" : {"type" : "string", "examples" : ["0.00"], "description" : "Available balance at loan account, including authorizations"}, "current" : {"type" : "string", "examples" : ["-107872.00"], "description" : "Current balance at bank account, excluding authorizations"}, "opening" : {"type" : "string", "examples" : ["-107872.00"], "description" : "Balance at the beginning of the current banking day"}}, "required" : ["available", "current", "opening"]}, "bankAccountTypeClass" : {"type" : "string", "examples" : ["loanAccount"], "description" : "BankAccountTypeClasses are unique per tenant and can be used for logic in the client.\r\n\r\n**Note!** New values might be added at any time and the client should have a default case for handling unknown bankAccountTypeClasses."}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Företagslån Plus"]}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : [""]}}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK"]}, "displayName" : {"type" : "string", "examples" : ["401-9568165-5544-43"]}, "expirationDate" : {"type" : "string", "examples" : ["2020-01-31"]}, "firstRepaymentDate" : {"type" : "string", "examples" : ["2019-12-31"]}, "interestPayable" : {"type" : "object", "properties" : {"accrued" : {"type" : ["string", "null"], "examples" : ["0.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "lastDate" : {"type" : ["string", "null"], "examples" : ["2021-12-31"]}, "rate" : {"type" : ["string", "null"], "examples" : ["0.00"]}, "total" : {"type" : ["string", "null"], "examples" : ["0.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}}, "required" : ["accrued", "lastDate", "rate", "total"]}, "interestReceivable" : {"type" : "object", "properties" : {"accrued" : {"type" : ["string", "null"], "examples" : ["-6172.62"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "lastDate" : {"type" : ["string", "null"], "examples" : ["2021-12-31"]}, "rate" : {"type" : ["string", "null"], "examples" : ["24.00"]}, "total" : {"type" : ["string", "null"], "examples" : ["247301.23"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}}, "required" : ["accrued", "lastDate", "rate", "total"]}, "loanAccountId" : {"type" : "string", "examples" : ["cc594e2a-aa54-4a01-82ca-88d539751c4a"], "format" : "uuid"}, "overdraftLimit" : {"type" : "string", "examples" : ["250000.00"]}, "repaymentAmount" : {"type" : "string", "examples" : ["100000.00"]}, "repaymentFrequency" : {"type" : "string", "examples" : ["monthly"], "enum" : ["daily", "weekly", "monthly", "quarterly", "semiAnnual", "annual", "endOfMaturity"], "description" : "**Note!** New values might be added at any time and it's up to the client how to handle unknown repaymentFrequencies."}, "repaymentMethod" : {"type" : "string", "examples" : ["manual"], "enum" : ["directDebit", "manual", "account"], "description" : "**Note!** New values might be added at any time and it's up to the client how to handle unknown repaymentMethods."}, "repaymentPeriods" : {"type" : "integer", "examples" : [5]}, "repaymentType" : {"type" : "string", "examples" : ["principal"], "enum" : ["annuity", "principal", "invoice", "directInvoice"], "description" : "**Note!** New values might be added at any time and it's up to the client how to handle unknown repaymentTypes."}, "status" : {"type" : "string", "examples" : ["open"], "enum" : ["open", "blocked"], "description" : "**Note!** New values might be added at any time and it's up to the client how to handle unknown statuses."}}, "required" : ["bankAccountTypeClass", "bankAccountTypeName", "balance", "capabilities", "currency", "displayName", "loanAccountId", "overdraftLimit", "status", "expirationDate", "firstRepaymentDate", "interestPayable", "interestReceivable", "repaymentAmount", "repaymentFrequency", "repaymentMethod", "repaymentPeriods", "repaymentType"]}}}}}}}, "\/psu\/{psuId}\/payment-order" : {"get" : {"operationId" : "psupsuIdpaymentorderget", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "List payment orders", "description" : "Read more about the Payment life cycle in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/payment-lifecycle)", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["123.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : ["edit"], "enum" : ["edit", "delete", "send"]}}, "creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankDisplayName" : {"type" : "string", "examples" : ["swedish account"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : "string", "examples" : ["Hej, hej"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 12}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"], "maxLength" : 140, "description" : "Name of the intended recipient"}}, "required" : ["clearingNumber", "bankAccountNumber", "name", "bankAccountCustomName", "bankDisplayName", "message"]}, {"title" : "ownBankAccount", "type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountId" : {"type" : "string", "examples" : ["ad5acb9d-a11a-4533-bf6a-870a2217bcfb"], "format" : "uuid"}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : ["string", "null"], "examples" : ["Hej, hej"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 120}}, "required" : ["bankAccountId", "clearingNumber", "bankAccountNumber", "bankAccountTypeName", "bankAccountCustomName", "message"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroCustomName" : {"type" : ["string", "null"], "examples" : ["5707-9055"]}, "bankGiroDisplayName" : {"type" : "string", "examples" : ["Tele2"]}, "bankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "message" : {"type" : "string", "examples" : ["1111111111138"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 25}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["soft", "hard", "hardWithVariableLength", "hardWithFixedLength", "noValidation"]}}, "required" : ["bankGiroNumber", "bankGiroDisplayName", "bankGiroCustomName", "message", "ocrValidationLevel"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"message" : {"type" : "string", "examples" : ["123456789"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 35}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["soft", "hard", "hardWithVariableLength", "hardWithFixedLength", "noValidation"]}, "plusGiroCustomName" : {"type" : ["string", "null"], "examples" : ["456123-9"]}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Telia Company"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["456123-9"], "pattern" : "^[0-9]{1,7}-?[0-9]$"}}, "required" : ["plusGiroNumber", "plusGiroDisplayName", "plusGiroCustomName", "message", "ocrValidationLevel"]}, {"title" : "preregisteredIban", "type" : "object", "properties" : {"addressLine1" : {"type" : "string", "examples" : ["Strandvägen 1"], "maxLength" : 40}, "addressLine2" : {"type" : ["string", "null"], "maxLength" : 40}, "bic" : {"type" : "string", "examples" : ["NDEASESS"], "maxLength" : 11, "minLength" : 8}, "city" : {"type" : "string", "examples" : ["Stockholm"], "maxLength" : 30}, "countryCode" : {"type" : "string", "examples" : ["SE"], "pattern" : "[A-Z]{2}", "description" : "Country code (ISO 3166-1 alpha-2)"}, "county" : {"type" : ["string", "null"], "examples" : ["Stockholm"], "maxLength" : 30}, "email" : {"type" : "string", "examples" : ["google@gmail.com"], "maxLength" : 60}, "iban" : {"type" : "string", "examples" : ["SE7280000810340009783242"], "pattern" : "^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,}$", "maxLength" : 34, "minLength" : 15}, "message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 70}, "name" : {"type" : "string", "examples" : ["Google"], "maxLength" : 60}, "paymentCode" : {"type" : ["string", "null"], "examples" : ["101"], "enum" : ["101", "122", "130", "131", "140", "141", "142", "143", "150", "160", "161", "162", "163", "173", "200", "201", "202", "221", "223", "300", "301", "302", "303", "310", "321", "331", "401", "402", "403", "410", "411", "412", "413", "423", "430", "431", "440", "441", "442", "450", "451", "452", "460", "461", "462", "470", "473", "473", "510", "520", "540", "550", "551", "552", "553", "560", "600", "601", "602", "603", "620", "622", "631", "633", "670", "681", "683", "701", "701", "710", "712", "723", "723", "751", "793", "801", "801", "803", "803", "831", "831", "833", "833", "881", "881", "883", "883", "893", "900", "900", "902", "902", "910", "910", "912", "912", "940", "941", "999"], "maxLength" : 10, "minLength" : 3}, "paymentFee" : {"type" : ["string", "null"], "examples" : ["123.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$", "description" : "A fee applied to payments below a specified minimum limit."}, "preregisteredAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "zipCode" : {"type" : "string", "examples" : ["11451"], "maxLength" : 10}}, "required" : ["preregisteredAccountId", "paymentCode", "message", "iban", "bic", "name", "email", "addressLine1", "addressLine2", "city", "county", "zipCode", "countryCode", "paymentFee"]}], "description" : "The creditor is the part receiving the payment"}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "ownBankAccount", "bankGiro", "plusGiro", "preregisteredIban"], "description" : "**Note!** New creditorTypes might be added at any time and it's up to the client how to handle unknown values."}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK", "EUR", "NOK", "USD", "GBP", "DKK", "PLN", "RON", "CZK", "HUF", "ISK", "CHF"]}, "debtor" : {"type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountId" : {"type" : "string", "examples" : ["ad5acb9d-a11a-4533-bf6a-870a2217bcfb"], "format" : "uuid"}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : ["string", "null"], "examples" : ["Description"], "maxLength" : 120}}, "required" : ["bankAccountId", "clearingNumber", "bankAccountNumber", "bankAccountTypeName", "bankAccountCustomName", "message"], "description" : "The debtor is the part sending the payment"}, "eInvoice" : {"type" : ["object", "null"], "properties" : {"link" : {"type" : ["string", "null"], "examples" : ["https:\/\/www.foretag.se\/fakturaid.jsp"]}, "unsignedTicket" : {"type" : "string", "examples" : ["eyJwYXllZSI6eyJmdWkiOiIwMDU1NjU3NTc3MzguMDIwMDAwMDAzNzguRlNQQS5TRSJ9fQ=="]}}, "required" : ["unsignedTicket", "link"]}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "overDue" : {"type" : "boolean", "examples" : [true]}, "paymentDate" : {"oneOf" : [{"title" : "Specific date", "type" : "string", "examples" : ["2026-10-12"], "format" : "date", "description" : "Send payment on the specified date"}, {"title" : "ASAP", "type" : "string", "examples" : ["ASAP"], "enum" : ["ASAP"], "description" : "Send payment as soon as possible"}]}, "paymentOrderId" : {"type" : "string", "examples" : ["d0125fa2-daf7-4e8b-a198-46e2c708918e"], "format" : "uuid"}, "signatories" : {"type" : "array", "items" : {"type" : ["object", "null"], "properties" : {"name" : {"type" : "string"}}, "required" : ["name"], "description" : "A person who has signed this payment"}}}, "required" : ["capabilities", "signatories", "eInvoice", "amount", "currency", "creditorType", "creditor", "debtor", "overDue", "paymentDate", "paymentOrderId", "externalPaymentReference"]}}}}}}}, "post" : {"operationId" : "psupsuIdpaymentorderpost", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "Register payment order", "description" : "Read more about the Payment life cycle in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/payment-lifecycle)", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["123.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["8003150359"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "clearingNumber" : {"type" : "string", "examples" : ["3300"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 12}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"], "maxLength" : 140, "description" : "Name of the intended recipient"}}, "required" : ["clearingNumber", "bankAccountNumber", "name", "message"]}, {"title" : "ownBankAccount", "type" : "object", "properties" : {"bankAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "message" : {"type" : ["string", "null"], "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 120}}, "required" : ["bankAccountId", "message"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroNumber" : {"type" : "string", "examples" : ["5395-9821"]}, "message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 25}}, "required" : ["bankGiroNumber", "message"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 35}, "plusGiroNumber" : {"type" : "string", "examples" : ["604148-7"]}}, "required" : ["plusGiroNumber", "message"]}, {"title" : "preregisteredIban", "type" : "object", "properties" : {"message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 70}, "paymentCode" : {"type" : ["string", "null"], "examples" : ["123"], "enum" : ["101", "122", "130", "131", "140", "141", "142", "143", "150", "160", "161", "162", "163", "173", "200", "201", "202", "221", "223", "300", "301", "302", "303", "310", "321", "331", "401", "402", "403", "410", "411", "412", "413", "423", "430", "431", "440", "441", "442", "450", "451", "452", "460", "461", "462", "470", "473", "473", "510", "520", "540", "550", "551", "552", "553", "560", "600", "601", "602", "603", "620", "622", "631", "633", "670", "681", "683", "701", "701", "710", "712", "723", "723", "751", "793", "801", "801", "803", "803", "831", "831", "833", "833", "881", "881", "883", "883", "893", "900", "900", "902", "902", "910", "910", "912", "912", "940", "941", "999"], "maxLength" : 10, "minLength" : 3}, "preregisteredAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}}, "required" : ["preregisteredAccountId", "paymentCode", "message"]}], "description" : "The creditor is the part receiving the payment"}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "ownBankAccount", "bankGiro", "plusGiro", "preregisteredIban"], "description" : "**Note!** New creditorTypes might be added at any time and it's up to the client how to handle unknown values."}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK", "EUR", "NOK", "USD", "GBP", "DKK", "PLN", "RON", "CZK", "HUF", "ISK", "CHF"], "description" : "Currencies other than SEK is only allowed for Iban payments"}, "debtor" : {"type" : "object", "properties" : {"bankAccountId" : {"type" : "string", "examples" : ["ad5acb9d-a11a-4533-bf6a-870a2217bcfb"], "format" : "uuid"}, "message" : {"type" : ["string", "null"], "examples" : ["Description"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 120}}, "required" : ["bankAccountId", "message"], "description" : "The debtor is the part sending the payment"}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "paymentDate" : {"oneOf" : [{"title" : "Specific date", "type" : "string", "examples" : ["2026-10-12"], "format" : "date", "description" : "Send payment on the specified date"}, {"title" : "ASAP", "type" : "string", "examples" : ["ASAP"], "enum" : ["ASAP"], "description" : "Send payment as soon as possible"}]}}, "required" : ["paymentDate", "amount", "currency", "creditorType", "creditor", "debtor"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"paymentOrderId" : {"type" : "string", "examples" : ["d0125fa2-daf7-4e8b-a198-46e2c708918e"], "format" : "uuid"}}, "required" : ["paymentOrderId"]}}}}}}}, "\/psu\/{psuId}\/payment-order\/send" : {"post" : {"operationId" : "psupsuIdpaymentordersendpost", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "Send registered payment orders", "description" : "Send request with array of paymentOrderIds. This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request. The response of the [**Verify**](\/operations\/signverifypost) request is a HTTP `202 Accepted` response with the payments.\r\n\r\nRead more about the Payment life cycle in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/payment-lifecycle)\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "string", "examples" : ["d0125fa2-daf7-4e8b-a198-46e2c708918e"], "format" : "uuid"}}}}}, "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "202" : {"description" : "Accepted", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["123.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : ["delete"], "enum" : ["delete"]}}, "creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankDisplayName" : {"type" : "string", "examples" : ["swedish account"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : "string", "examples" : ["Hej, hej"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 12}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"], "maxLength" : 140, "description" : "Name of the intended recipient"}}, "required" : ["clearingNumber", "bankAccountNumber", "name", "bankAccountCustomName", "bankDisplayName", "message"]}, {"title" : "ownBankAccount", "type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountId" : {"type" : "string", "examples" : ["ad5acb9d-a11a-4533-bf6a-870a2217bcfb"], "format" : "uuid"}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : ["string", "null"], "examples" : ["Hej, hej"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 120}}, "required" : ["bankAccountId", "clearingNumber", "bankAccountNumber", "bankAccountTypeName", "bankAccountCustomName", "message"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroCustomName" : {"type" : ["string", "null"], "examples" : ["5707-9055"]}, "bankGiroDisplayName" : {"type" : "string", "examples" : ["Tele2"]}, "bankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "message" : {"type" : "string", "examples" : ["1111111111138"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 25}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["soft", "hard", "hardWithVariableLength", "hardWithFixedLength", "noValidation"]}}, "required" : ["bankGiroNumber", "bankGiroDisplayName", "bankGiroCustomName", "message", "ocrValidationLevel"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"message" : {"type" : "string", "examples" : ["123456789"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 35}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["soft", "hard", "hardWithVariableLength", "hardWithFixedLength", "noValidation"]}, "plusGiroCustomName" : {"type" : ["string", "null"], "examples" : ["456123-9"]}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Telia Company"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["456123-9"], "pattern" : "^[0-9]{1,7}-?[0-9]$"}}, "required" : ["plusGiroNumber", "plusGiroDisplayName", "plusGiroCustomName", "message", "ocrValidationLevel"]}, {"title" : "preregisteredIban", "type" : "object", "properties" : {"addressLine1" : {"type" : "string", "examples" : ["Strandvägen 1"], "maxLength" : 40}, "addressLine2" : {"type" : ["string", "null"], "maxLength" : 40}, "bic" : {"type" : "string", "examples" : ["NDEASESS"], "maxLength" : 11, "minLength" : 8}, "city" : {"type" : "string", "examples" : ["Stockholm"], "maxLength" : 30}, "countryCode" : {"type" : "string", "examples" : ["SE"], "pattern" : "[A-Z]{2}", "description" : "Country code (ISO 3166-1 alpha-2)"}, "county" : {"type" : ["string", "null"], "examples" : ["Stockholm"], "maxLength" : 30}, "email" : {"type" : "string", "examples" : ["google@gmail.com"], "maxLength" : 60}, "iban" : {"type" : "string", "examples" : ["SE7280000810340009783242"], "pattern" : "^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,}$", "maxLength" : 34, "minLength" : 15}, "message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 70}, "name" : {"type" : "string", "examples" : ["Google"], "maxLength" : 60}, "paymentCode" : {"type" : ["string", "null"], "examples" : ["101"], "enum" : ["101", "122", "130", "131", "140", "141", "142", "143", "150", "160", "161", "162", "163", "173", "200", "201", "202", "221", "223", "300", "301", "302", "303", "310", "321", "331", "401", "402", "403", "410", "411", "412", "413", "423", "430", "431", "440", "441", "442", "450", "451", "452", "460", "461", "462", "470", "473", "473", "510", "520", "540", "550", "551", "552", "553", "560", "600", "601", "602", "603", "620", "622", "631", "633", "670", "681", "683", "701", "701", "710", "712", "723", "723", "751", "793", "801", "801", "803", "803", "831", "831", "833", "833", "881", "881", "883", "883", "893", "900", "900", "902", "902", "910", "910", "912", "912", "940", "941", "999"], "maxLength" : 10, "minLength" : 3}, "paymentFee" : {"type" : ["string", "null"], "examples" : ["123.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$", "description" : "A fee applied to payments below a specified minimum limit."}, "preregisteredAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "zipCode" : {"type" : "string", "examples" : ["11451"], "maxLength" : 10}}, "required" : ["preregisteredAccountId", "paymentCode", "message", "iban", "bic", "name", "email", "addressLine1", "addressLine2", "city", "county", "zipCode", "countryCode", "paymentFee"]}], "description" : "The creditor is the part receiving the payment"}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "ownBankAccount", "bankGiro", "plusGiro", "preregisteredIban"], "description" : "**Note!** New creditorTypes might be added at any time and it's up to the client how to handle unknown values."}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK", "EUR", "NOK", "USD", "GBP", "DKK", "PLN", "RON", "CZK", "HUF", "ISK", "CHF"]}, "debtor" : {"type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountId" : {"type" : "string", "examples" : ["ad5acb9d-a11a-4533-bf6a-870a2217bcfb"], "format" : "uuid"}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : ["string", "null"], "examples" : ["Description"], "maxLength" : 120}}, "required" : ["bankAccountId", "clearingNumber", "bankAccountNumber", "bankAccountTypeName", "bankAccountCustomName", "message"], "description" : "The debtor is the part sending the payment"}, "eInvoice" : {"type" : ["object", "null"], "properties" : {"link" : {"type" : ["string", "null"], "examples" : ["https:\/\/www.foretag.se\/fakturaid.jsp"]}, "unsignedTicket" : {"type" : "string", "examples" : ["eyJwYXllZSI6eyJmdWkiOiIwMDU1NjU3NTc3MzguMDIwMDAwMDAzNzguRlNQQS5TRSJ9fQ=="]}}, "required" : ["unsignedTicket", "link"]}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "overDue" : {"type" : "boolean", "examples" : [true]}, "paymentDate" : {"oneOf" : [{"title" : "Specific date", "type" : "string", "examples" : ["2026-10-12"], "format" : "date", "description" : "Send payment on the specified date"}, {"title" : "ASAP", "type" : "string", "examples" : ["ASAP"], "enum" : ["ASAP"], "description" : "Send payment as soon as possible"}]}, "paymentOrderId" : {"type" : "string", "examples" : ["d0125fa2-daf7-4e8b-a198-46e2c708918e"], "format" : "uuid"}, "signatories" : {"type" : "array", "items" : {"type" : ["object", "null"], "properties" : {"name" : {"type" : "string"}}, "required" : ["name"], "description" : "A person who has signed this payment"}}}, "required" : ["capabilities", "signatories", "eInvoice", "amount", "currency", "creditorType", "creditor", "debtor", "overDue", "paymentDate", "paymentOrderId", "externalPaymentReference"]}}}}}}}}, "\/psu\/{psuId}\/payment-order\/preliminary-amount" : {"post" : {"operationId" : "psupsuIdpaymentorderpreliminaryamountpost", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "Get preliminary amount for international payment", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["12.06"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "currency" : {"type" : "string", "examples" : ["EUR"], "enum" : ["SEK", "EUR", "NOK", "USD", "DKK", "PLN", "RON", "CZK", "HUF", "ISK", "CHF"]}, "debtorCurrency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK"]}}, "required" : ["amount", "currency", "debtorCurrency"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"creditorAmount" : {"type" : "string", "examples" : ["12.06"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "creditorCurrency" : {"type" : "string", "examples" : ["EUR"], "enum" : ["SEK", "EUR", "NOK", "USD", "DKK", "PLN", "RON", "CZK", "HUF", "ISK", "CHF"]}, "debtorAmount" : {"type" : "string", "examples" : ["137.42"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "debtorCurrency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK"]}, "exchangeRate" : {"type" : "string", "examples" : ["11.395000"], "pattern" : "^-?[0-9]+\\.[0-9]{6}$"}, "exchangeRateWithMargin" : {"type" : "string", "examples" : ["11.395000"], "pattern" : "^-?[0-9]+\\.[0-9]{6}$", "description" : "Use exchangeRate instead, will be removed earliest 2025-03-31. Same value as exchangeRate since all rates are with margins.", "deprecated" : true}}, "required" : ["creditorAmount", "creditorCurrency", "debtorAmount", "debtorCurrency", "exchangeRate", "exchangeRateWithMargin"]}}}}}}}, "\/psu\/{psuId}\/payment-order\/{paymentOrderId}" : {"put" : {"operationId" : "psupsuIdpaymentorderpaymentOrderIdput", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "Update payment order", "description" : "Read more about the Payment life cycle in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/payment-lifecycle)", "parameters" : [{"$ref" : "#\/components\/parameters\/paymentOrderId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["123.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["8003150359"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "clearingNumber" : {"type" : "string", "examples" : ["3300"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 12}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"], "maxLength" : 140, "description" : "Name of the intended recipient"}}, "required" : ["clearingNumber", "bankAccountNumber", "name", "message"]}, {"title" : "ownBankAccount", "type" : "object", "properties" : {"bankAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "message" : {"type" : ["string", "null"], "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 120}}, "required" : ["bankAccountId", "message"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroNumber" : {"type" : "string", "examples" : ["5395-9821"]}, "message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 25}}, "required" : ["bankGiroNumber", "message"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 35}, "plusGiroNumber" : {"type" : "string", "examples" : ["604148-7"]}}, "required" : ["plusGiroNumber", "message"]}, {"title" : "preregisteredIban", "type" : "object", "properties" : {"message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 70}, "paymentCode" : {"type" : ["string", "null"], "examples" : ["123"], "enum" : ["101", "122", "130", "131", "140", "141", "142", "143", "150", "160", "161", "162", "163", "173", "200", "201", "202", "221", "223", "300", "301", "302", "303", "310", "321", "331", "401", "402", "403", "410", "411", "412", "413", "423", "430", "431", "440", "441", "442", "450", "451", "452", "460", "461", "462", "470", "473", "473", "510", "520", "540", "550", "551", "552", "553", "560", "600", "601", "602", "603", "620", "622", "631", "633", "670", "681", "683", "701", "701", "710", "712", "723", "723", "751", "793", "801", "801", "803", "803", "831", "831", "833", "833", "881", "881", "883", "883", "893", "900", "900", "902", "902", "910", "910", "912", "912", "940", "941", "999"], "maxLength" : 10, "minLength" : 3}, "preregisteredAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}}, "required" : ["preregisteredAccountId", "paymentCode", "message"]}], "description" : "The creditor is the part receiving the payment"}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "ownBankAccount", "bankGiro", "plusGiro", "preregisteredIban"], "description" : "**Note!** New creditorTypes might be added at any time and it's up to the client how to handle unknown values."}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK", "EUR", "NOK", "USD", "GBP", "DKK", "PLN", "RON", "CZK", "HUF", "ISK", "CHF"], "description" : "Currencies other than SEK is only allowed for Iban payments"}, "debtor" : {"type" : "object", "properties" : {"bankAccountId" : {"type" : "string", "examples" : ["ad5acb9d-a11a-4533-bf6a-870a2217bcfb"], "format" : "uuid"}, "message" : {"type" : ["string", "null"], "examples" : ["Description"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 120}}, "required" : ["bankAccountId", "message"], "description" : "The debtor is the part sending the payment"}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "paymentDate" : {"oneOf" : [{"title" : "Specific date", "type" : "string", "examples" : ["2026-10-12"], "format" : "date", "description" : "Send payment on the specified date"}, {"title" : "ASAP", "type" : "string", "examples" : ["ASAP"], "enum" : ["ASAP"], "description" : "Send payment as soon as possible"}]}}, "required" : ["paymentDate", "amount", "currency", "creditorType", "creditor", "debtor"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"paymentOrderId" : {"type" : "string", "examples" : ["d0125fa2-daf7-4e8b-a198-46e2c708918e"], "format" : "uuid"}}, "required" : ["paymentOrderId"]}}}}}}, "delete" : {"operationId" : "psupsuIdpaymentorderpaymentOrderIddelete", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "Delete payment order", "description" : "Read more about the Payment life cycle in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/payment-lifecycle)", "parameters" : [{"$ref" : "#\/components\/parameters\/paymentOrderId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/bank-account\/{bankAccountId}\/payment-order\/upload-bg-file" : {"post" : {"operationId" : "psupsuIdbankaccountbankAccountIdpaymentorderuploadbgfilepost", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "Upload bankgiro file", "description" : "\r\n## LB files\r\nSupplier payments (\"leverantörsbetalningar\") are supported.\r\n\r\n#### Supported features\r\nThe following features of the LB file format are supported: (TKXX refers to record types in file)\r\n\r\n* Payment to BankGiro with OCR number (TK14)\r\n* Payment to BankGiro with message (TK14 + TK25)\r\n* Payment to PlusGiro with OCR number (TK54)\r\n* Payment to PlusGiro with message (TK54 + TK65)\r\n* Payment to Bank account (TK40 + TK14 [+TK65])\r\n* Verify number and sum of payments (TK29)\r\n\r\n#### Ignored features\r\nThe following features of the LB file format are silently ignored (ie will neither cause an error or trigger any functionality) : (TKXX refers to record types in file)\r\n\r\n* Common payment date (TK11)\r\n* Information record (TK12)\r\n* Header record (TK13)\r\n\r\n#### Not supported features\r\nThe following features of the LB file format are not supported and will result in an error : (TKXX refers to record types in file)\r\n\r\n* Multiple sections (TK11)\r\n* Credit, rebate etc (TK15, TK16, TK17)\r\n* Notification by mail (TK26, TK27)\r\n* Foreign payments (TK0 - TK9)\r\n\r\n## Bg Lön files\r\nSalary payments (\"löneutbetalningar\") are supported. All three record types (TK01, TK35 and TK09) are supported.\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/bankAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"multipart\/form-data" : {"schema" : {"type" : "object", "properties" : {"fileName" : {"type" : "string", "format" : "binary"}}}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"paymentOrderId" : {"type" : "string", "examples" : ["d0125fa2-daf7-4e8b-a198-46e2c708918e"], "format" : "uuid"}}, "required" : ["paymentOrderId"]}}}}}}}}, "\/psu\/{psuId}\/upcoming-payment" : {"get" : {"operationId" : "psupsuIdupcomingpaymentget", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "List upcoming payments", "description" : "Read more about the Payment life cycle in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/payment-lifecycle)", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["123.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : ["edit"], "enum" : ["edit", "delete", "send"]}}, "creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankDisplayName" : {"type" : "string", "examples" : ["swedish account"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : "string", "examples" : ["Hej, hej"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 12}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"], "maxLength" : 140, "description" : "Name of the intended recipient"}}, "required" : ["clearingNumber", "bankAccountNumber", "name", "bankAccountCustomName", "bankDisplayName", "message"]}, {"title" : "ownBankAccount", "type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountId" : {"type" : "string", "examples" : ["ad5acb9d-a11a-4533-bf6a-870a2217bcfb"], "format" : "uuid"}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : ["string", "null"], "examples" : ["Hej, hej"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 120}}, "required" : ["bankAccountId", "clearingNumber", "bankAccountNumber", "bankAccountTypeName", "bankAccountCustomName", "message"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroCustomName" : {"type" : ["string", "null"], "examples" : ["5707-9055"]}, "bankGiroDisplayName" : {"type" : "string", "examples" : ["Tele2"]}, "bankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "message" : {"type" : "string", "examples" : ["1111111111138"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 25}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["soft", "hard", "hardWithVariableLength", "hardWithFixedLength", "noValidation"]}}, "required" : ["bankGiroNumber", "bankGiroDisplayName", "bankGiroCustomName", "message", "ocrValidationLevel"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"message" : {"type" : "string", "examples" : ["123456789"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 35}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["soft", "hard", "hardWithVariableLength", "hardWithFixedLength", "noValidation"]}, "plusGiroCustomName" : {"type" : ["string", "null"], "examples" : ["456123-9"]}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Telia Company"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["456123-9"], "pattern" : "^[0-9]{1,7}-?[0-9]$"}}, "required" : ["plusGiroNumber", "plusGiroDisplayName", "plusGiroCustomName", "message", "ocrValidationLevel"]}, {"title" : "preregisteredIban", "type" : "object", "properties" : {"addressLine1" : {"type" : "string", "examples" : ["Strandvägen 1"], "maxLength" : 40}, "addressLine2" : {"type" : ["string", "null"], "maxLength" : 40}, "bic" : {"type" : "string", "examples" : ["NDEASESS"], "maxLength" : 11, "minLength" : 8}, "city" : {"type" : "string", "examples" : ["Stockholm"], "maxLength" : 30}, "countryCode" : {"type" : "string", "examples" : ["SE"], "pattern" : "[A-Z]{2}", "description" : "Country code (ISO 3166-1 alpha-2)"}, "county" : {"type" : ["string", "null"], "examples" : ["Stockholm"], "maxLength" : 30}, "email" : {"type" : "string", "examples" : ["google@gmail.com"], "maxLength" : 60}, "iban" : {"type" : "string", "examples" : ["SE7280000810340009783242"], "pattern" : "^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,}$", "maxLength" : 34, "minLength" : 15}, "message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 70}, "name" : {"type" : "string", "examples" : ["Google"], "maxLength" : 60}, "paymentCode" : {"type" : ["string", "null"], "examples" : ["101"], "enum" : ["101", "122", "130", "131", "140", "141", "142", "143", "150", "160", "161", "162", "163", "173", "200", "201", "202", "221", "223", "300", "301", "302", "303", "310", "321", "331", "401", "402", "403", "410", "411", "412", "413", "423", "430", "431", "440", "441", "442", "450", "451", "452", "460", "461", "462", "470", "473", "473", "510", "520", "540", "550", "551", "552", "553", "560", "600", "601", "602", "603", "620", "622", "631", "633", "670", "681", "683", "701", "701", "710", "712", "723", "723", "751", "793", "801", "801", "803", "803", "831", "831", "833", "833", "881", "881", "883", "883", "893", "900", "900", "902", "902", "910", "910", "912", "912", "940", "941", "999"], "maxLength" : 10, "minLength" : 3}, "paymentFee" : {"type" : ["string", "null"], "examples" : ["123.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$", "description" : "A fee applied to payments below a specified minimum limit."}, "preregisteredAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "zipCode" : {"type" : "string", "examples" : ["11451"], "maxLength" : 10}}, "required" : ["preregisteredAccountId", "paymentCode", "message", "iban", "bic", "name", "email", "addressLine1", "addressLine2", "city", "county", "zipCode", "countryCode", "paymentFee"]}], "description" : "The creditor is the part receiving the payment"}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "ownBankAccount", "bankGiro", "plusGiro", "preregisteredIban"], "description" : "**Note!** New creditorTypes might be added at any time and it's up to the client how to handle unknown values."}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK", "EUR", "NOK", "USD", "GBP", "DKK", "PLN", "RON", "CZK", "HUF", "ISK", "CHF"]}, "debtor" : {"type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountId" : {"type" : "string", "examples" : ["ad5acb9d-a11a-4533-bf6a-870a2217bcfb"], "format" : "uuid"}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : ["string", "null"], "examples" : ["Description"], "maxLength" : 120}}, "required" : ["bankAccountId", "clearingNumber", "bankAccountNumber", "bankAccountTypeName", "bankAccountCustomName", "message"], "description" : "The debtor is the part sending the payment"}, "eInvoice" : {"type" : ["object", "null"], "properties" : {"link" : {"type" : ["string", "null"], "examples" : ["https:\/\/www.foretag.se\/fakturaid.jsp"]}, "unsignedTicket" : {"type" : "string", "examples" : ["eyJwYXllZSI6eyJmdWkiOiIwMDU1NjU3NTc3MzguMDIwMDAwMDAzNzguRlNQQS5TRSJ9fQ=="]}}, "required" : ["unsignedTicket", "link"]}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "overDue" : {"type" : "boolean", "examples" : [true]}, "paymentDate" : {"oneOf" : [{"title" : "Specific date", "type" : "string", "examples" : ["2026-10-12"], "format" : "date", "description" : "Send payment on the specified date"}, {"title" : "ASAP", "type" : "string", "examples" : ["ASAP"], "enum" : ["ASAP"], "description" : "Send payment as soon as possible"}]}, "paymentOrderId" : {"type" : "string", "examples" : ["d0125fa2-daf7-4e8b-a198-46e2c708918e"], "format" : "uuid"}, "signatories" : {"type" : "array", "items" : {"type" : ["object", "null"], "properties" : {"name" : {"type" : "string"}}, "required" : ["name"], "description" : "A person who has signed this payment"}}}, "required" : ["capabilities", "signatories", "eInvoice", "amount", "currency", "creditorType", "creditor", "debtor", "overDue", "paymentDate", "paymentOrderId", "externalPaymentReference"]}}}}}}}}, "\/psu\/{psuId}\/upcoming-payment\/{paymentOrderId}" : {"delete" : {"operationId" : "psupsuIdupcomingpaymentpaymentOrderIddelete", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "Cancel upcoming payment", "description" : "Read more about the Payment life cycle in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/payment-lifecycle)", "parameters" : [{"$ref" : "#\/components\/parameters\/paymentOrderId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/failed-payment" : {"get" : {"operationId" : "psupsuIdfailedpaymentget", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "List failed payments", "description" : "Read more about the Payment life cycle in the [**Developer resources**](https:\/\/baasdeveloperdemo.svea.com\/resources\/payment-lifecycle)", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["123.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "capabilities" : {"type" : "array", "description" : "**Note!** New values might be added at any time and should be ignored if the client does not know how to handle them.", "items" : {"type" : "string", "examples" : ["delete"], "enum" : ["delete"]}}, "creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankDisplayName" : {"type" : "string", "examples" : ["swedish account"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : "string", "examples" : ["Hej, hej"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 12}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"], "maxLength" : 140, "description" : "Name of the intended recipient"}}, "required" : ["clearingNumber", "bankAccountNumber", "name", "bankAccountCustomName", "bankDisplayName", "message"]}, {"title" : "ownBankAccount", "type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountId" : {"type" : "string", "examples" : ["ad5acb9d-a11a-4533-bf6a-870a2217bcfb"], "format" : "uuid"}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : ["string", "null"], "examples" : ["Hej, hej"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 120}}, "required" : ["bankAccountId", "clearingNumber", "bankAccountNumber", "bankAccountTypeName", "bankAccountCustomName", "message"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroCustomName" : {"type" : ["string", "null"], "examples" : ["5707-9055"]}, "bankGiroDisplayName" : {"type" : "string", "examples" : ["Tele2"]}, "bankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "message" : {"type" : "string", "examples" : ["1111111111138"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 25}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["soft", "hard", "hardWithVariableLength", "hardWithFixedLength", "noValidation"]}}, "required" : ["bankGiroNumber", "bankGiroDisplayName", "bankGiroCustomName", "message", "ocrValidationLevel"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"message" : {"type" : "string", "examples" : ["123456789"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 35}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["soft", "hard", "hardWithVariableLength", "hardWithFixedLength", "noValidation"]}, "plusGiroCustomName" : {"type" : ["string", "null"], "examples" : ["456123-9"]}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Telia Company"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["456123-9"], "pattern" : "^[0-9]{1,7}-?[0-9]$"}}, "required" : ["plusGiroNumber", "plusGiroDisplayName", "plusGiroCustomName", "message", "ocrValidationLevel"]}, {"title" : "preregisteredIban", "type" : "object", "properties" : {"addressLine1" : {"type" : "string", "examples" : ["Strandvägen 1"], "maxLength" : 40}, "addressLine2" : {"type" : ["string", "null"], "maxLength" : 40}, "bic" : {"type" : "string", "examples" : ["NDEASESS"], "maxLength" : 11, "minLength" : 8}, "city" : {"type" : "string", "examples" : ["Stockholm"], "maxLength" : 30}, "countryCode" : {"type" : "string", "examples" : ["SE"], "pattern" : "[A-Z]{2}", "description" : "Country code (ISO 3166-1 alpha-2)"}, "county" : {"type" : ["string", "null"], "examples" : ["Stockholm"], "maxLength" : 30}, "email" : {"type" : "string", "examples" : ["google@gmail.com"], "maxLength" : 60}, "iban" : {"type" : "string", "examples" : ["SE7280000810340009783242"], "pattern" : "^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,}$", "maxLength" : 34, "minLength" : 15}, "message" : {"type" : "string", "examples" : ["A message"], "pattern" : "^[ a-zA-Z0-9åäöÅÄÖ,.-]+$", "maxLength" : 70}, "name" : {"type" : "string", "examples" : ["Google"], "maxLength" : 60}, "paymentCode" : {"type" : ["string", "null"], "examples" : ["101"], "enum" : ["101", "122", "130", "131", "140", "141", "142", "143", "150", "160", "161", "162", "163", "173", "200", "201", "202", "221", "223", "300", "301", "302", "303", "310", "321", "331", "401", "402", "403", "410", "411", "412", "413", "423", "430", "431", "440", "441", "442", "450", "451", "452", "460", "461", "462", "470", "473", "473", "510", "520", "540", "550", "551", "552", "553", "560", "600", "601", "602", "603", "620", "622", "631", "633", "670", "681", "683", "701", "701", "710", "712", "723", "723", "751", "793", "801", "801", "803", "803", "831", "831", "833", "833", "881", "881", "883", "883", "893", "900", "900", "902", "902", "910", "910", "912", "912", "940", "941", "999"], "maxLength" : 10, "minLength" : 3}, "paymentFee" : {"type" : ["string", "null"], "examples" : ["123.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$", "description" : "A fee applied to payments below a specified minimum limit."}, "preregisteredAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "zipCode" : {"type" : "string", "examples" : ["11451"], "maxLength" : 10}}, "required" : ["preregisteredAccountId", "paymentCode", "message", "iban", "bic", "name", "email", "addressLine1", "addressLine2", "city", "county", "zipCode", "countryCode", "paymentFee"]}], "description" : "The creditor is the part receiving the payment"}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "ownBankAccount", "bankGiro", "plusGiro", "preregisteredIban"], "description" : "**Note!** New creditorTypes might be added at any time and it's up to the client how to handle unknown values."}, "currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK", "EUR", "NOK", "USD", "GBP", "DKK", "PLN", "RON", "CZK", "HUF", "ISK", "CHF"]}, "debtor" : {"type" : "object", "properties" : {"bankAccountCustomName" : {"type" : ["string", "null"], "examples" : ["9669-8590276"]}, "bankAccountId" : {"type" : "string", "examples" : ["ad5acb9d-a11a-4533-bf6a-870a2217bcfb"], "format" : "uuid"}, "bankAccountNumber" : {"type" : "string", "examples" : ["8590276"], "pattern" : "^[0-9]{1,20}$", "maxLength" : 20}, "bankAccountTypeName" : {"type" : "string", "examples" : ["Transaktionskonto"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "pattern" : "^[0-9]{4,5}$", "maxLength" : 6}, "message" : {"type" : ["string", "null"], "examples" : ["Description"], "maxLength" : 120}}, "required" : ["bankAccountId", "clearingNumber", "bankAccountNumber", "bankAccountTypeName", "bankAccountCustomName", "message"], "description" : "The debtor is the part sending the payment"}, "eInvoice" : {"type" : ["object", "null"], "properties" : {"link" : {"type" : ["string", "null"], "examples" : ["https:\/\/www.foretag.se\/fakturaid.jsp"]}, "unsignedTicket" : {"type" : "string", "examples" : ["eyJwYXllZSI6eyJmdWkiOiIwMDU1NjU3NTc3MzguMDIwMDAwMDAzNzguRlNQQS5TRSJ9fQ=="]}}, "required" : ["unsignedTicket", "link"]}, "externalPaymentReference" : {"type" : ["string", "null"], "examples" : ["Invoice #42"], "maxLength" : 120, "description" : "Can be used by external parties to connect a payment through it's lifecycle with a resource on their side."}, "failureReason" : {"type" : "string", "examples" : ["InsufficientFunds"], "enum" : ["TechnicalError", "InsufficientFunds", "InvalidPaymentDate", "InvalidValueDate", "AccountClosed", "Unknown"]}, "overDue" : {"type" : "boolean", "examples" : [true]}, "paymentDate" : {"oneOf" : [{"title" : "Specific date", "type" : "string", "examples" : ["2026-10-12"], "format" : "date", "description" : "Send payment on the specified date"}, {"title" : "ASAP", "type" : "string", "examples" : ["ASAP"], "enum" : ["ASAP"], "description" : "Send payment as soon as possible"}]}, "paymentOrderId" : {"type" : "string", "examples" : ["d0125fa2-daf7-4e8b-a198-46e2c708918e"], "format" : "uuid"}}, "required" : ["failureReason", "capabilities", "eInvoice", "amount", "currency", "creditorType", "creditor", "debtor", "overDue", "paymentDate", "paymentOrderId", "externalPaymentReference"]}}}}}}}}, "\/psu\/{psuId}\/failed-payment\/{paymentOrderId}\/mark-as-read" : {"post" : {"operationId" : "psupsuIdfailedpaymentpaymentOrderIdmarkasreadpost", "security" : [{"Bearer" : []}], "tags" : ["Payment"], "summary" : "Mark failed payment as read", "parameters" : [{"$ref" : "#\/components\/parameters\/paymentOrderId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/%s\/duality\/payment-order" : {"get" : {"operationId" : "psusdualitypaymentorderget", "security" : [{"Bearer" : []}], "tags" : ["PSU"], "summary" : "Get the duality setting for payment orders", "description" : "Returns whether the payment order duality is currently enabled for the PSU", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"enabled" : {"type" : "boolean", "examples" : [true]}}, "required" : ["enabled"]}}}}}}, "patch" : {"operationId" : "psusdualitypaymentorderpatch", "security" : [{"Bearer" : []}], "tags" : ["PSU"], "summary" : "Update the duality setting for payment orders", "description" : "Enable or disable payment order duality for this PSU. Note that it is not possible to enable duality for a private person PSU. Read more about the concepts Tenant, PSU and delegate in the [**Developer resources**]({devPortalUrl}\/resources\/tenant-psu-delegate). This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request. The response of the [**Verify**](\/operations\/signverifypost) request is `204 Not Content` with an empty body.", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"enabled" : {"type" : "boolean", "examples" : [true]}}, "required" : ["enabled"]}}}}, "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/international-payment\/preregistered-debtor" : {"get" : {"operationId" : "psupsuIdinternationalpaymentpreregistereddebtorget", "security" : [{"Bearer" : []}], "tags" : ["International Payment"], "summary" : "List preregistered debtors", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"addressLine1" : {"type" : "string", "examples" : ["Skalitzer Str. 129"]}, "addressLine2" : {"type" : ["string", "null"]}, "city" : {"type" : "string", "examples" : ["Berlin"]}, "country" : {"type" : "string", "examples" : ["DE"], "description" : "Use countryCode instead", "deprecated" : true}, "countryCode" : {"type" : "string", "examples" : ["DE"]}, "county" : {"type" : ["string", "null"]}, "email" : {"type" : "string", "examples" : ["germany@test.com"]}, "name" : {"type" : "string", "examples" : ["Das Boot"]}, "preregisteredDebtorId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "type" : {"type" : "string", "examples" : ["Person"], "enum" : ["person", "organization"]}, "zipCode" : {"type" : "string", "examples" : ["10999"]}}, "required" : ["preregisteredDebtorId", "type", "name", "email", "addressLine1", "addressLine2", "zipCode", "city", "county", "country", "countryCode"]}}}}}}}}, "\/psu\/{psuId}\/international-payment\/preregistered-account" : {"get" : {"operationId" : "psupsuIdinternationalpaymentpreregisteredaccountget", "security" : [{"Bearer" : []}], "tags" : ["International Payment"], "summary" : "List preregistered creditor accounts", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"addressLine1" : {"type" : "string", "examples" : ["Testvägen 1"]}, "addressLine2" : {"type" : ["string", "null"]}, "bic" : {"type" : "string", "examples" : ["SVEASESS"]}, "city" : {"type" : "string", "examples" : ["Stockholm"]}, "country" : {"type" : "string", "examples" : ["SE"], "description" : "Use countryCode instead", "deprecated" : true}, "countryCode" : {"type" : "string", "examples" : ["SE"]}, "county" : {"type" : ["string", "null"]}, "email" : {"type" : "string", "examples" : ["testbolaget@test.com"]}, "iban" : {"type" : "string", "examples" : ["SE2196600000096693065548"]}, "name" : {"type" : "string", "examples" : ["Testbolaget AB"]}, "preregisteredAccountId" : {"type" : "string", "examples" : ["fe4cf362-f99f-41ee-af0b-90b012bbf5c6"], "format" : "uuid"}, "type" : {"type" : "string", "examples" : ["organization"], "enum" : ["person", "organization"]}, "zipCode" : {"type" : "string", "examples" : ["12345"]}}, "required" : ["preregisteredAccountId", "iban", "bic", "type", "name", "email", "addressLine1", "addressLine2", "zipCode", "city", "county", "country", "countryCode"]}}}}}}}}, "\/psu\/{psuId}\/international-payment\/preregistered-debtor\/{preregisteredDebtorId}" : {"delete" : {"operationId" : "psupsuIdinternationalpaymentpreregistereddebtorpreregisteredDebtorIddelete", "security" : [{"Bearer" : []}], "tags" : ["International Payment"], "summary" : "Delete the preregistered debtor account", "parameters" : [{"$ref" : "#\/components\/parameters\/preregisteredDebtorId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/international-payment\/preregistered-account\/{preregisteredAccountId}" : {"delete" : {"operationId" : "psupsuIdinternationalpaymentpreregisteredaccountpreregisteredAccountIddelete", "security" : [{"Bearer" : []}], "tags" : ["International Payment"], "summary" : "Delete the preregistered creditor account", "parameters" : [{"$ref" : "#\/components\/parameters\/preregisteredAccountId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/international-payment\/payment-fee-settings" : {"get" : {"operationId" : "psupsuIdinternationalpaymentpaymentfeesettingsget", "security" : [{"Bearer" : []}], "tags" : ["International Payment"], "summary" : "List current payment fee settings", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"currency" : {"type" : "string", "examples" : ["SEK"], "enum" : ["SEK"]}, "fixedFeeAmount" : {"type" : ["string", "null"], "examples" : ["50.00"], "pattern" : "[0-9]{1,}\\.[0-9]{2}", "description" : "The fixed fee amount"}, "minimumLimitAmount" : {"type" : ["string", "null"], "examples" : ["300.00"], "pattern" : "[0-9]{1,}\\.[0-9]{2}", "description" : "The minimum limit amount"}}, "required" : ["fixedFeeAmount", "minimumLimitAmount", "currency"], "description" : "**Note!** If a setting is inactive the value of that setting will be `null`."}}}}}}}, "\/psu\/{psuId}\/international-payment\/currency" : {"get" : {"operationId" : "psupsuIdinternationalpaymentcurrencyget", "security" : [{"Bearer" : []}], "tags" : ["International Payment"], "summary" : "List allowed currencies", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"currencyCode" : {"type" : "string", "examples" : ["SEK"], "pattern" : "[A-Z]{3}", "description" : "Currency code (ISO 4217)"}}, "required" : ["currencyCode"]}}}}}}}}, "\/psu\/{psuId}\/international-payment\/country" : {"get" : {"operationId" : "psupsuIdinternationalpaymentcountryget", "security" : [{"Bearer" : []}], "tags" : ["International Payment"], "summary" : "List allowed countries", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"countryCode" : {"type" : "string", "examples" : ["SE"], "pattern" : "[A-Z]{2}", "description" : "Country code (ISO 3166-1 alpha-2)"}}, "required" : ["countryCode"]}}}}}}}}, "\/psu\/{psuId}\/creditor\/saved" : {"get" : {"operationId" : "psupsuIdcreditorsavedget", "security" : [{"Bearer" : []}], "tags" : ["Creditor"], "summary" : "List saved creditors", "parameters" : [{"$ref" : "#\/components\/parameters\/type"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["3065548"]}, "bankDisplayName" : {"type" : "string", "examples" : ["Svea Bank AB"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"]}}, "required" : ["name", "customName", "clearingNumber", "bankAccountNumber", "bankDisplayName", "creditorType"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Svea Ekonomi AB"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["774058-2"]}}, "required" : ["customName", "plusGiroNumber", "plusGiroDisplayName", "ocrValidationLevel", "creditorType"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroDisplayName" : {"type" : "string", "examples" : ["Svea Ekonomi AB"]}, "bankGiroNumber" : {"type" : "string", "examples" : ["5091-4076"]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}}, "required" : ["customName", "bankGiroNumber", "bankGiroDisplayName", "ocrValidationLevel", "creditorType"]}]}, "creditorId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "**Note!** New creditorTypes might be added at any time and should be ignored if the client does not know how to handle them."}}, "required" : ["creditorId", "creditorType", "creditor"]}}}}}}}, "post" : {"operationId" : "psupsuIdcreditorsavedpost", "security" : [{"Bearer" : []}], "tags" : ["Creditor"], "summary" : "Create saved creditor", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["3065548"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"], "maxLength" : 140}}, "required" : ["name", "customName", "clearingNumber", "bankAccountNumber", "creditorType"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["774058-2"]}}, "required" : ["customName", "plusGiroNumber", "creditorType"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroNumber" : {"type" : "string", "examples" : ["5091-4076"]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}}, "required" : ["customName", "bankGiroNumber", "creditorType"]}]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "**Note!** New creditorTypes might be added at any time and should be ignored if the client does not know how to handle them."}}, "required" : ["creditorType", "creditor"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["3065548"]}, "bankDisplayName" : {"type" : "string", "examples" : ["Svea Bank AB"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"]}}, "required" : ["name", "customName", "clearingNumber", "bankAccountNumber", "bankDisplayName", "creditorType"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Svea Ekonomi AB"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["774058-2"]}}, "required" : ["customName", "plusGiroNumber", "plusGiroDisplayName", "ocrValidationLevel", "creditorType"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroDisplayName" : {"type" : "string", "examples" : ["Svea Ekonomi AB"]}, "bankGiroNumber" : {"type" : "string", "examples" : ["5091-4076"]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}}, "required" : ["customName", "bankGiroNumber", "bankGiroDisplayName", "ocrValidationLevel", "creditorType"]}]}, "creditorId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "**Note!** New creditorTypes might be added at any time and should be ignored if the client does not know how to handle them."}}, "required" : ["creditorId", "creditorType", "creditor"]}}}}}}, "put" : {"operationId" : "psupsuIdcreditorsavedput", "security" : [{"Bearer" : []}], "tags" : ["Creditor"], "summary" : "Create or update saved creditor", "description" : "This endpoint matches on BankAccount, BankGiro or PlusGiro and decide whether to create or update a saved creditor", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["3065548"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"], "maxLength" : 140}}, "required" : ["name", "customName", "clearingNumber", "bankAccountNumber", "creditorType"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["774058-2"]}}, "required" : ["customName", "plusGiroNumber", "creditorType"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroNumber" : {"type" : "string", "examples" : ["5091-4076"]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}}, "required" : ["customName", "bankGiroNumber", "creditorType"]}]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "**Note!** New creditorTypes might be added at any time and should be ignored if the client does not know how to handle them."}}, "required" : ["creditorType", "creditor"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["3065548"]}, "bankDisplayName" : {"type" : "string", "examples" : ["Svea Bank AB"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "name" : {"type" : ["string", "null"], "examples" : ["Sven Svensson"]}}, "required" : ["name", "customName", "clearingNumber", "bankAccountNumber", "bankDisplayName", "creditorType"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Svea Ekonomi AB"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["774058-2"]}}, "required" : ["customName", "plusGiroNumber", "plusGiroDisplayName", "ocrValidationLevel", "creditorType"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroDisplayName" : {"type" : "string", "examples" : ["Svea Ekonomi AB"]}, "bankGiroNumber" : {"type" : "string", "examples" : ["5091-4076"]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "Use the property of the same name one level up instead.", "deprecated" : true}, "customName" : {"type" : ["string", "null"], "examples" : ["A custom name"]}, "ocrValidationLevel" : {"type" : ["string", "null"], "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}}, "required" : ["customName", "bankGiroNumber", "bankGiroDisplayName", "ocrValidationLevel", "creditorType"]}]}, "creditorId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "**Note!** New creditorTypes might be added at any time and should be ignored if the client does not know how to handle them."}}, "required" : ["creditorId", "creditorType", "creditor"]}}}}}}}, "\/psu\/{psuId}\/creditor\/saved\/{creditorId}" : {"delete" : {"operationId" : "psupsuIdcreditorsavedcreditorIddelete", "security" : [{"Bearer" : []}], "tags" : ["Creditor"], "summary" : "Delete saved creditor", "parameters" : [{"$ref" : "#\/components\/parameters\/creditorId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/creditor\/lookup" : {"post" : {"operationId" : "psupsuIdcreditorlookuppost", "security" : [{"Bearer" : []}], "tags" : ["Creditor"], "summary" : "Lookup creditors", "description" : "\r\n### OCR validation levels\r\nFor reference, see https:\/\/www.bankgirot.se\/tjanster\/inbetalningar\/bankgiro-inbetalningar\/ocr-referenskontroll\/\r\n\r\nValid OCRs use the well known Luhn algorithm to produce a checksum.\r\nIn some cases, the next to last digit will also bear meaning.\r\n\r\nValidation levels:\r\n* noValidation - No validation, will accept any text\r\n* soft - Prefers a valid Luhn number, but the payment will accept any text\r\n* hard - Requires a valid Luhn number, will not accept anything else\r\n* hardWithVariableLength - Same as hard, except the next to last digit must be the number of digits mod 10\r\n* hardWithFixedLength - Same as hardWithVariableLength, except the length can only be one of 1-2 values specified in advance\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"numberGuess" : {"type" : "string", "examples" : ["96692474932"]}, "numberType" : {"type" : "string", "examples" : ["guess"], "enum" : ["bankGiro", "plusGiro", "bankGiroOrPlusGiro", "swedishBankAccount", "guess"], "description" : "**Note!** New numberTypes might be added at any time"}}, "required" : ["numberType", "numberGuess"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["2474932"], "description" : "Use the properties on 'creditor' instead", "deprecated" : true}, "bankDisplayName" : {"type" : "string", "examples" : ["Svea Bank AB"], "description" : "Use the properties on 'creditor' instead", "deprecated" : true}, "clearingNumber" : {"type" : "string", "examples" : ["9669"], "description" : "Use the properties on 'creditor' instead", "deprecated" : true}, "creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["2474932"]}, "bankDisplayName" : {"type" : "string", "examples" : ["Svea Bank AB"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "iban" : {"type" : ["string", "null"], "examples" : ["SE4796600000096692474932"], "pattern" : "[A-Za-z]{2}[A-Za-z0-9]+"}}, "required" : ["clearingNumber", "bankAccountNumber", "bankDisplayName", "iban"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroDisplayName" : {"type" : "string", "examples" : ["Tele2"]}, "bankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "ocrValidationLevel" : {"type" : "string", "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}}, "required" : ["bankGiroNumber", "bankGiroDisplayName", "ocrValidationLevel"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"ocrValidationLevel" : {"type" : "string", "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Telia Company"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["456123-9"], "pattern" : "^[0-9]{1,7}-?[0-9]$"}}, "required" : ["plusGiroNumber", "plusGiroDisplayName", "ocrValidationLevel"]}]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "**Note!** New creditorTypes might be added at any time and should be ignored if the client does not know how to handle them."}, "iban" : {"type" : ["string", "null"], "examples" : ["SE4796600000096692474932"], "pattern" : "[A-Za-z]{2}[A-Za-z0-9]+", "description" : "Use the properties on 'creditor' instead", "deprecated" : true}}, "required" : ["creditorType", "creditor", "clearingNumber", "bankAccountNumber", "bankDisplayName", "iban"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroDisplayName" : {"type" : "string", "examples" : ["Tele2"], "description" : "Use the properties on 'creditor' instead", "deprecated" : true}, "bankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$", "description" : "Use the properties on 'creditor' instead", "deprecated" : true}, "creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["2474932"]}, "bankDisplayName" : {"type" : "string", "examples" : ["Svea Bank AB"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "iban" : {"type" : ["string", "null"], "examples" : ["SE4796600000096692474932"], "pattern" : "[A-Za-z]{2}[A-Za-z0-9]+"}}, "required" : ["clearingNumber", "bankAccountNumber", "bankDisplayName", "iban"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroDisplayName" : {"type" : "string", "examples" : ["Tele2"]}, "bankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "ocrValidationLevel" : {"type" : "string", "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}}, "required" : ["bankGiroNumber", "bankGiroDisplayName", "ocrValidationLevel"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"ocrValidationLevel" : {"type" : "string", "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Telia Company"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["456123-9"], "pattern" : "^[0-9]{1,7}-?[0-9]$"}}, "required" : ["plusGiroNumber", "plusGiroDisplayName", "ocrValidationLevel"]}]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "**Note!** New creditorTypes might be added at any time and should be ignored if the client does not know how to handle them."}, "ocrValidationLevel" : {"type" : "string", "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"], "description" : "Use the properties on 'creditor' instead", "deprecated" : true}}, "required" : ["creditorType", "creditor", "bankGiroNumber", "bankGiroDisplayName", "ocrValidationLevel"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"creditor" : {"oneOf" : [{"title" : "swedishBankAccount", "type" : "object", "properties" : {"bankAccountNumber" : {"type" : "string", "examples" : ["2474932"]}, "bankDisplayName" : {"type" : "string", "examples" : ["Svea Bank AB"]}, "clearingNumber" : {"type" : "string", "examples" : ["9669"]}, "iban" : {"type" : ["string", "null"], "examples" : ["SE4796600000096692474932"], "pattern" : "[A-Za-z]{2}[A-Za-z0-9]+"}}, "required" : ["clearingNumber", "bankAccountNumber", "bankDisplayName", "iban"]}, {"title" : "bankGiro", "type" : "object", "properties" : {"bankGiroDisplayName" : {"type" : "string", "examples" : ["Tele2"]}, "bankGiroNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "ocrValidationLevel" : {"type" : "string", "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}}, "required" : ["bankGiroNumber", "bankGiroDisplayName", "ocrValidationLevel"]}, {"title" : "plusGiro", "type" : "object", "properties" : {"ocrValidationLevel" : {"type" : "string", "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"]}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Telia Company"]}, "plusGiroNumber" : {"type" : "string", "examples" : ["456123-9"], "pattern" : "^[0-9]{1,7}-?[0-9]$"}}, "required" : ["plusGiroNumber", "plusGiroDisplayName", "ocrValidationLevel"]}]}, "creditorType" : {"type" : "string", "examples" : ["swedishBankAccount"], "enum" : ["swedishBankAccount", "plusGiro", "bankGiro"], "description" : "**Note!** New creditorTypes might be added at any time and should be ignored if the client does not know how to handle them."}, "ocrValidationLevel" : {"type" : "string", "examples" : ["noValidation"], "enum" : ["noValidation", "soft", "hard", "hardWithVariableLength", "hardWithFixedLength"], "description" : "Use the properties on 'creditor' instead", "deprecated" : true}, "plusGiroDisplayName" : {"type" : "string", "examples" : ["Telia Company"], "description" : "Use the properties on 'creditor' instead", "deprecated" : true}, "plusGiroNumber" : {"type" : "string", "examples" : ["456123-9"], "pattern" : "^[0-9]{1,7}-?[0-9]$", "description" : "Use the properties on 'creditor' instead", "deprecated" : true}}, "required" : ["creditorType", "creditor", "plusGiroNumber", "plusGiroDisplayName", "ocrValidationLevel"]}]}}}}}}}}, "\/psu\/{psuId}\/creditor\/validate-ocr" : {"post" : {"operationId" : "psupsuIdcreditorvalidateocrpost", "security" : [{"Bearer" : []}], "tags" : ["Creditor"], "summary" : "OCR validation", "description" : "\r\nThe result has the following meanings:\r\n* noValidationSupported - corresponds to noValidation level\r\n* valid - corresponds to any level except noValidation, if valid\r\n* invalidMayBeAccepted - corresponds to soft, invalid OCR but should in most cases just warn the user\r\n* invalidWillNotBeAccepted - corresponds to all three hard levels, payment order will not succeed\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"accountNumber" : {"type" : "string", "examples" : ["5707-9055"], "pattern" : "^([0-9]{3,4}-?[0-9]{4})|([0-9]{1,7}-?[0-9])$"}, "accountNumberType" : {"type" : "string", "examples" : ["bankGiro"], "enum" : ["bankGiro", "plusGiro"]}, "ocrNumber" : {"type" : "string", "examples" : ["123456789"]}}, "required" : ["accountNumberType", "accountNumber", "ocrNumber"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"result" : {"type" : "string", "examples" : ["valid"], "enum" : ["noValidationSupported", "valid", "invalidMayBeAccepted", "invalidWillNotBeAccepted"]}}, "required" : ["result"]}}}}}}}, "\/psu\/{psuId}\/e-invoice\/issuer\/lookup" : {"post" : {"operationId" : "psupsuIdeinvoiceissuerlookuppost", "security" : [{"Bearer" : []}], "tags" : ["E-Invoice"], "summary" : "Lookup issuers", "description" : "Search for issuers which offers E-Invoice. The call will result in a paginated list of issuers.", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"page" : {"type" : ["integer", "null"], "examples" : [1]}, "pageSize" : {"type" : ["integer", "null"], "examples" : [20]}, "query" : {"type" : "string", "examples" : ["SEB"]}}, "required" : ["query", "page", "pageSize"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"data" : {"type" : "array", "items" : {"type" : "object", "properties" : {"bgPgNumber" : {"type" : "string", "examples" : ["5257-0595"]}, "consentStatus" : {"type" : "string", "examples" : ["activeConsent"], "enum" : ["activeConsent", "unknown"]}, "consentType" : {"type" : "string", "examples" : ["payment"], "enum" : ["payment", "link"]}, "issuerName" : {"type" : "string", "examples" : ["SEB BOLÅN"]}, "links" : {"type" : "object", "properties" : {"consent" : {"type" : "string", "examples" : ["http:\/\/www.bgc.se\/default____8924.aspx"]}, "info" : {"type" : "string", "examples" : ["http:\/\/www.e-giro.se\/information\/556079-9172\/information.htm"]}}, "required" : ["consent", "info"]}, "organizationNumber" : {"type" : "string", "examples" : ["556079-9172"]}, "requiresTicket" : {"type" : "boolean", "examples" : [true]}, "unsignedTicket" : {"type" : "string", "examples" : ["eyJwYXllZSI6eyJmdWkiOiIwMDU1NjA3OTkxNzIuMDAwMDU5MDkwODAuU0VCLlNFIn19"]}}, "required" : ["bgPgNumber", "consentStatus", "consentType", "issuerName", "organizationNumber", "requiresTicket", "links", "unsignedTicket"]}}, "pagination" : {"type" : "object", "properties" : {"page" : {"type" : "integer", "examples" : [1]}, "pageSize" : {"type" : "integer", "examples" : [20]}, "totalHits" : {"type" : "integer", "examples" : [1]}}, "required" : ["page", "pageSize", "totalHits"]}}, "required" : ["data", "pagination"]}}}}}}}, "\/psu\/{psuId}\/e-invoice\/issuer\/lookup-by-creditors" : {"post" : {"operationId" : "psupsuIdeinvoiceissuerlookupbycreditorspost", "security" : [{"Bearer" : []}], "tags" : ["E-Invoice"], "summary" : "Lookup issuers by creditors", "description" : "Search for issuers which offers E-Invoice by creditor number. Both bankgiro and plusgiro numbers can be provided.", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankGiroNumbers" : {"type" : "array", "items" : {"type" : "string", "examples" : ["5257-0595"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}}, "plusGiroNumbers" : {"type" : "array", "items" : {"type" : "string", "examples" : ["604148-7"], "pattern" : "^[0-9]{1,7}-?[0-9]$"}}}, "required" : ["bankGiroNumbers", "plusGiroNumbers"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankGiroNumbers" : {"type" : "array", "items" : {"type" : "object", "properties" : {"bankGiroNumber" : {"type" : "string", "examples" : ["5257-0595"], "pattern" : "^[0-9]{3,4}-?[0-9]{4}$"}, "issuers" : {"type" : "array", "items" : {"type" : "object", "properties" : {"bgPgNumber" : {"type" : "string", "examples" : ["5257-0595"]}, "consentStatus" : {"type" : "string", "examples" : ["activeConsent"], "enum" : ["activeConsent", "unknown"]}, "consentType" : {"type" : "string", "examples" : ["payment"], "enum" : ["payment", "link"]}, "issuerName" : {"type" : "string", "examples" : ["SEB BOLÅN"]}, "links" : {"type" : "object", "properties" : {"consent" : {"type" : "string", "examples" : ["http:\/\/www.bgc.se\/default____8924.aspx"]}, "info" : {"type" : "string", "examples" : ["http:\/\/www.e-giro.se\/information\/556079-9172\/information.htm"]}}, "required" : ["consent", "info"]}, "organizationNumber" : {"type" : "string", "examples" : ["556079-9172"]}, "requiresTicket" : {"type" : "boolean", "examples" : [true]}, "unsignedTicket" : {"type" : "string", "examples" : ["eyJwYXllZSI6eyJmdWkiOiIwMDU1NjA3OTkxNzIuMDAwMDU5MDkwODAuU0VCLlNFIn19"]}}, "required" : ["bgPgNumber", "consentStatus", "consentType", "issuerName", "organizationNumber", "requiresTicket", "links", "unsignedTicket"]}}}, "required" : ["bankGiroNumber", "issuers"]}}, "plusGiroNumbers" : {"type" : "array", "items" : {"type" : "object", "properties" : {"issuers" : {"type" : "array", "items" : {"type" : "object", "properties" : {"bgPgNumber" : {"type" : "string", "examples" : ["604148-7"]}, "consentStatus" : {"type" : "string", "examples" : ["activeConsent"], "enum" : ["activeConsent", "unknown"]}, "consentType" : {"type" : "string", "examples" : ["link"], "enum" : ["payment", "link"]}, "issuerName" : {"type" : "string", "examples" : ["BREDBANDSBOLAGET"]}, "links" : {"type" : "object", "properties" : {"consent" : {"type" : "string", "examples" : ["http:\/\/www.bgc.se\/default____8924.aspx"]}, "info" : {"type" : "string", "examples" : ["http:\/\/www.bredbandsbolaget.se"]}}, "required" : ["consent", "info"]}, "organizationNumber" : {"type" : "string", "examples" : ["556575-7738"]}, "requiresTicket" : {"type" : "boolean", "examples" : [true]}, "unsignedTicket" : {"type" : "string", "examples" : ["eyJwYXllZSI6eyJmdWkiOiIwMDU1NjU3NTc3MzguMDIwMDAwMDAzNzguRlNQQS5TRSJ9fQ=="]}}, "required" : ["bgPgNumber", "consentStatus", "consentType", "issuerName", "organizationNumber", "requiresTicket", "links", "unsignedTicket"]}}, "plusGiroNumber" : {"type" : "string", "examples" : ["604148-7"], "pattern" : "^[0-9]{1,7}-?[0-9]$"}}, "required" : ["plusGiroNumber", "issuers"]}}}, "required" : ["bankGiroNumbers", "plusGiroNumbers"]}}}}}}}, "\/psu\/{psuId}\/e-invoice\/consent\/register-by-invoice" : {"post" : {"operationId" : "psupsuIdeinvoiceconsentregisterbyinvoicepost", "security" : [{"Bearer" : []}], "tags" : ["E-Invoice"], "summary" : "Register consent by invoice", "description" : "Register a consent to give permissions receiving E-Invoice from an issuer", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"amount" : {"type" : "string", "examples" : ["123.00"]}, "bgPgNumber" : {"type" : "string", "examples" : ["5257-0595"]}, "ocr" : {"type" : "string", "examples" : ["234234234234"]}, "paymentDate" : {"type" : "string", "examples" : ["2000-01-01"], "format" : "date"}}, "required" : ["bgPgNumber", "paymentDate", "amount", "ocr"]}}}}, "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/e-invoice\/consent" : {"delete" : {"operationId" : "psupsuIdeinvoiceconsentdelete", "security" : [{"Bearer" : []}], "tags" : ["E-Invoice"], "summary" : "Delete consent", "description" : "Delete a consent to retrieve permissions receiving E-Invoice from an issuer", "parameters" : [{"$ref" : "#\/components\/parameters\/bgPgNumber"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}, "get" : {"operationId" : "psupsuIdeinvoiceconsentget", "security" : [{"Bearer" : []}], "tags" : ["E-Invoice"], "summary" : "List consents", "description" : "The call will result in a paginated list of consents for the psu.", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"activated" : {"type" : "string", "examples" : ["2019-01-01"], "format" : "date"}, "bgPgNumber" : {"type" : "string", "examples" : ["5257-0595"]}, "infoLink" : {"type" : "string", "examples" : ["http:\/\/www2.e-giro.se\/..\/information\/mall\/information.htm"], "format" : "uri"}, "issuerName" : {"type" : "string", "examples" : ["DANSKE BANK, GULD- OCH FÖRETAGSKORT"]}, "organizationNumber" : {"type" : "string", "examples" : ["556047-3521"]}, "status" : {"type" : "string", "examples" : ["pending"], "enum" : ["pending", "active", "inactive"]}}, "required" : ["issuerName", "organizationNumber", "bgPgNumber", "infoLink", "status", "activated"]}}}}}}}}, "\/psu\/{psuId}\/e-invoice\/ticket" : {"post" : {"operationId" : "psupsuIdeinvoiceticketpost", "security" : [{"Bearer" : []}], "tags" : ["E-Invoice"], "summary" : "Sign ticket", "description" : "\r\nSign ticket can be used to view a received e-invoice on the issuers document service.\r\nAn unsigned ticket and a link to the issuers document service can be found in inbox messages with E-Invoice context and in e-invoice payments.\r\nIn order for the user to open the link, the unsigned ticket needs to be signed.\r\n", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"unsignedTicket" : {"type" : "string", "examples" : ["ew0KICAgICJwYXllZSI6IHsNCiAgICAgICAgImZ1aSI6ICJmdWkiDQogICAgfQ0KfQ0K"]}}, "required" : ["unsignedTicket"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"ticket" : {"type" : "string", "examples" : ["Very long string..."]}}, "required" : ["ticket"]}}}}}}}, "\/psu\/{psuId}\/swish\/enrollment" : {"post" : {"operationId" : "psupsuIdswishenrollmentpost", "security" : [{"Bearer" : []}], "tags" : ["Swish"], "summary" : "Post swish enrollment", "description" : "This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request.\r\n        The response of the [**Verify**](\/operations\/signverifypost) request is a HTTP `202 Accepted` response.", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankAccountId" : {"type" : "string", "examples" : ["6eb6b206-9a91-410b-ae92-def5f5fe363e"], "format" : "uuid"}, "enrollmentContext" : {"oneOf" : [{"title" : "organization", "type" : "object", "properties" : {"swishNumber" : {"type" : ["string", "null"], "examples" : ["1234567890"], "pattern" : "^123[0-8][0-9]{6}$"}}, "required" : ["swishNumber"]}, {"title" : "commerce", "type" : "object", "properties" : {"technicalSupplierNumber" : {"type" : ["string", "null"], "examples" : ["9872134037"], "pattern" : "^987[0-6][0-9]{6}$"}}, "required" : ["technicalSupplierNumber"]}, {"title" : "person", "type" : "object", "properties" : {"msisdn" : {"type" : "string", "examples" : ["46703834315"], "pattern" : "^(45|46|47|358)[1-9][0-9]{8,12}$"}}, "required" : ["msisdn"]}]}, "enrollmentContextType" : {"type" : "string", "examples" : ["organization"], "enum" : ["organization", "person", "commerce"]}}, "required" : ["bankAccountId", "enrollmentContextType", "enrollmentContext"]}}}}, "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "202" : {"description" : "Accepted", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}, "get" : {"operationId" : "psupsuIdswishenrollmentget", "security" : [{"Bearer" : []}], "tags" : ["Swish"], "summary" : "List enrollments", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"bankAccountId" : {"type" : "string", "examples" : ["6eb6b206-9a91-410b-ae92-def5f5fe363e"], "format" : "uuid"}, "enrollmentContext" : {"oneOf" : [{"title" : "organization", "type" : "object", "properties" : {"businessName" : {"type" : "string", "examples" : ["Företag AB"]}, "organizationKey" : {"type" : "string", "examples" : ["165520010017"]}, "swishNumber" : {"type" : "string", "examples" : ["1231477678"], "pattern" : "^123[0-8][0-9]{6}$"}}, "required" : ["swishNumber", "organizationKey", "businessName"]}, {"title" : "commerce", "type" : "object", "properties" : {"businessName" : {"type" : ["string", "null"], "examples" : ["Företag AB"]}, "organizationKey" : {"type" : "string", "examples" : ["165520010017"]}, "swishNumber" : {"type" : "string", "examples" : ["1231477678"], "pattern" : "^123[0-8][0-9]{6}$"}, "technicalSupplier" : {"type" : ["object", "null"], "properties" : {"displayName" : {"type" : ["string", "null"]}, "name" : {"type" : "string", "description" : "The technical supplier name."}, "organizationKey" : {"type" : "string", "pattern" : "^[1-9][0-9]{11}$"}, "recurring" : {"type" : "boolean", "examples" : [false], "description" : "True if recurring payments is allowed for this enrollment"}, "technicalSupplierNumber" : {"type" : "string", "examples" : ["9872134037"], "pattern" : "^987[0-6][0-9]{6}$"}}, "required" : ["displayName", "name", "organizationKey", "technicalSupplierNumber", "recurring"]}}, "required" : ["swishNumber", "organizationKey", "businessName", "technicalSupplier"]}, {"title" : "payout", "type" : "object", "properties" : {"businessName" : {"type" : ["string", "null"], "examples" : ["Företag AB"]}, "organizationKey" : {"type" : "string", "examples" : ["165520010017"]}, "swishNumber" : {"type" : "string", "examples" : ["1231477678"], "pattern" : "^123[0-8][0-9]{6}$"}, "technicalSupplier" : {"type" : ["object", "null"], "properties" : {"displayName" : {"type" : ["string", "null"]}, "name" : {"type" : "string", "description" : "The technical supplier name."}, "organizationKey" : {"type" : "string", "pattern" : "^[1-9][0-9]{11}$"}, "technicalSupplierNumber" : {"type" : "string", "examples" : ["9872134037"], "pattern" : "^987[0-6][0-9]{6}$"}}, "required" : ["displayName", "name", "organizationKey", "technicalSupplierNumber"]}}, "required" : ["swishNumber", "organizationKey", "businessName", "technicalSupplier"]}, {"title" : "person", "type" : "object", "properties" : {"dailyMax" : {"type" : "string", "examples" : ["5000.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "msisdn" : {"type" : "string", "examples" : ["46701234567"], "pattern" : "^(45|46|47|358)[1-9][0-9]{8,12}$"}, "personKey" : {"type" : "string", "examples" : ["198105236189"]}, "temporaryMaxAmount" : {"type" : ["object", "null"], "properties" : {"amount" : {"type" : "string", "examples" : ["150000.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "validDate" : {"type" : "string", "examples" : ["2020-10-10"], "format" : "date"}}, "required" : ["amount", "validDate"]}, "weeklyMax" : {"type" : "string", "examples" : ["10000.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}}, "required" : ["dailyMax", "weeklyMax", "msisdn", "personKey"]}]}, "enrollmentContextType" : {"type" : "string", "examples" : ["organization"], "enum" : ["organization", "person", "commerce", "payout"]}, "enrollmentId" : {"type" : "string", "examples" : ["9551114d-be0b-4afd-9f44-6b0d76851e88"], "format" : "uuid"}, "name" : {"type" : "string", "examples" : ["Företag AB"]}, "supportedPayments" : {"type" : "string", "examples" : ["receiveOnly"], "enum" : ["sendAndReceive", "receiveOnly"]}}, "required" : ["name", "enrollmentId", "bankAccountId", "supportedPayments", "enrollmentContextType", "enrollmentContext"]}}}}}}}}, "\/psu\/{psuId}\/swish\/enrollment\/{enrollmentId}\/bank-account" : {"put" : {"operationId" : "psupsuIdswishenrollmentenrollmentIdbankaccountput", "security" : [{"Bearer" : []}], "tags" : ["Swish"], "summary" : "Put swish enrollment bank account", "description" : "This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request.\r\n        The response of the [**Verify**](\/operations\/signverifypost) request is a HTTP `202 Accepted` response.", "parameters" : [{"$ref" : "#\/components\/parameters\/enrollmentId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"bankAccountId" : {"type" : "string", "examples" : ["6eb6b206-9a91-410b-ae92-def5f5fe363e"], "format" : "uuid"}}, "required" : ["bankAccountId"]}}}}, "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "202" : {"description" : "Accepted", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/swish\/enrollment\/{enrollmentId}" : {"delete" : {"operationId" : "psupsuIdswishenrollmentenrollmentIddelete", "security" : [{"Bearer" : []}], "tags" : ["Swish"], "summary" : "Delete swish enrollment", "description" : "This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request.\r\nThe response of the [**Verify**](\/operations\/signverifypost) request is an HTTP `204 No Content` response.", "parameters" : [{"$ref" : "#\/components\/parameters\/enrollmentId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/swish\/enrollment\/{enrollmentId}\/cpocs" : {"get" : {"operationId" : "psupsuIdswishenrollmentenrollmentIdcpocsget", "security" : [{"Bearer" : []}], "tags" : ["Swish"], "summary" : "List CPOCs", "description" : "Lists the Certificate Point of Contacts (CPOCs) for the given enrollment ", "parameters" : [{"$ref" : "#\/components\/parameters\/enrollmentId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"email" : {"type" : "string", "examples" : ["test@tester.com"]}, "mobileNumber" : {"type" : "string", "examples" : ["46760203751"]}, "name" : {"type" : "string", "examples" : ["Marten Tornquist"]}, "personKey" : {"type" : "string", "examples" : ["199711072398"]}}, "required" : ["email", "mobileNumber", "name", "personKey"]}}}}}}}}, "\/psu\/{psuId}\/swish\/msisdn\/verification-token\/send" : {"post" : {"operationId" : "psupsuIdswishmsisdnverificationtokensendpost", "security" : [{"Bearer" : []}], "tags" : ["Swish Person"], "summary" : "Send verification token for swish enrollment", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"countryCode" : {"type" : "string", "examples" : ["+46"]}, "domesticNumber" : {"type" : "string", "examples" : ["070-123 45 67"], "description" : "A potential leading 0 (zero), dash or hyphen, and white spaces will be cleaned from the input."}}, "required" : ["countryCode", "domesticNumber"]}}}}, "responses" : {"202" : {"description" : "Accepted", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/swish\/msisdn\/verification-token\/verify" : {"post" : {"operationId" : "psupsuIdswishmsisdnverificationtokenverifypost", "security" : [{"Bearer" : []}], "tags" : ["Swish Person"], "summary" : "Verify token for swish enrollment", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"countryCode" : {"type" : "string", "examples" : ["+46"]}, "domesticNumber" : {"type" : "string", "examples" : ["070-123 45 67"], "description" : "A potential leading 0 (zero), dash or hyphen, and white spaces will be cleaned from the input."}, "token" : {"type" : "string", "examples" : ["ABC123"]}}, "required" : ["countryCode", "token", "domesticNumber"]}}}}, "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"swishAlias" : {"type" : "string", "examples" : ["46701234567"]}}, "required" : ["swishAlias"]}}}}}}}, "\/psu\/{psuId}\/swish\/msisdn\/country-codes" : {"get" : {"operationId" : "psupsuIdswishmsisdncountrycodesget", "security" : [{"Bearer" : []}], "tags" : ["Swish Person"], "summary" : "List valid country codes for swish msisdn", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "string", "examples" : ["+46"]}}}}}}}}, "\/psu\/{psuId}\/swish\/msisdn" : {"get" : {"operationId" : "psupsuIdswishmsisdnget", "security" : [{"Bearer" : []}], "tags" : ["Swish Person"], "summary" : "List swish aliases", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"enrollmentId" : {"type" : ["string", "null"], "examples" : ["90445962-aadc-41a2-b689-f1e5b534b235"], "format" : "uuid"}, "msisdn" : {"type" : "string", "examples" : ["46701234567"]}, "status" : {"type" : "string", "examples" : ["active"], "enum" : ["active", "deletedBySwish", "deletedByHolder"]}}, "required" : ["msisdn", "enrollmentId", "status"]}}}}}}}}, "\/psu\/{psuId}\/swish\/enrollment\/{enrollmentId}\/settings" : {"put" : {"operationId" : "psupsuIdswishenrollmentenrollmentIdsettingsput", "security" : [{"Bearer" : []}], "tags" : ["Swish Person"], "summary" : "Put swish enrollment settings", "description" : "This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request.\r\n        The response of the [**Verify**](\/operations\/signverifypost) request is a HTTP `202 Accepted` response", "parameters" : [{"$ref" : "#\/components\/parameters\/enrollmentId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"enrollmentSettingsContext" : {"oneOf" : [{"title" : "sendAndReceiveContext", "type" : "object", "properties" : {"dailyMax" : {"type" : "string", "examples" : ["5000.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}, "weeklyMax" : {"type" : "string", "examples" : ["12000.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$"}}, "required" : ["dailyMax", "weeklyMax"]}]}, "enrollmentSettingsType" : {"type" : "string", "examples" : ["sendAndReceive"], "enum" : ["sendAndReceive", "receiveOnly"]}}, "required" : ["enrollmentSettingsType", "enrollmentSettingsContext"]}}}}, "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "202" : {"description" : "Accepted", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/swish\/default-settings" : {"get" : {"operationId" : "psupsuIdswishdefaultsettingsget", "security" : [{"Bearer" : []}], "tags" : ["Swish Person"], "summary" : "Get global swish settings and defaults", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"dailyLimit" : {"type" : ["object", "null"], "properties" : {"default" : {"type" : "string", "examples" : ["5000.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$", "description" : "Default limit"}, "max" : {"type" : "string", "examples" : ["5000.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$", "description" : "Maximum allowed limit"}}, "required" : ["default", "max"], "description" : "Settings for daily limit"}, "validCountryCodes" : {"type" : "array", "items" : {"type" : "string", "examples" : ["+46"]}}, "weeklyLimit" : {"type" : ["object", "null"], "properties" : {"default" : {"type" : "string", "examples" : ["5000.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$", "description" : "Default limit"}, "max" : {"type" : "string", "examples" : ["5000.00"], "pattern" : "^-?[0-9]{1,10}\\.[0-9]{2}$", "description" : "Maximum allowed limit"}}, "required" : ["default", "max"], "description" : "Settings for weekly limit"}}, "required" : ["validCountryCodes", "dailyLimit", "weeklyLimit"]}}}}}}}, "\/psu\/{psuId}\/swish\/enrollment\/{enrollmentId}\/technical-supplier" : {"put" : {"operationId" : "psupsuIdswishenrollmentenrollmentIdtechnicalsupplierput", "security" : [{"Bearer" : []}], "tags" : ["Swish Technical Supplier"], "summary" : "Put swish commerce enrollment technical supplier", "description" : "This request will result in a signing redirect HTTP `313 Needs Signing`. You must call [**Verify**](\/operations\/signverifypost) to complete the request.\r\n        The response of the [**Verify**](\/operations\/signverifypost) request is a HTTP `202 Accepted` response", "parameters" : [{"$ref" : "#\/components\/parameters\/enrollmentId"}, {"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"technicalSupplierNumber" : {"type" : ["string", "null"], "examples" : ["9871234567"]}}, "required" : ["technicalSupplierNumber"]}}}}, "responses" : {"313" : {"description" : "Needs Signing", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"signingToken" : {"type" : "string", "examples" : ["cd4a7661-82f4-44bc-9939-1ead1e496363"], "format" : "uuid"}}, "required" : ["signingToken"]}}}}, "202" : {"description" : "Accepted", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/psu\/{psuId}\/swish\/technical-supplier" : {"get" : {"operationId" : "psupsuIdswishtechnicalsupplierget", "security" : [{"Bearer" : []}], "tags" : ["Swish Technical Supplier"], "summary" : "List technical suppliers for Swish", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "array", "items" : {"type" : "object", "properties" : {"displayName" : {"type" : ["string", "null"], "examples" : ["VIV extra"]}, "name" : {"type" : "string", "examples" : ["VIV"]}, "organizationKey" : {"type" : "string", "examples" : ["5566414446"], "pattern" : "^[0-9]{10}$"}, "technicalSupplierNumber" : {"type" : "string", "examples" : ["9872134037"], "pattern" : "^987[0-9]{7}$"}}, "required" : ["organizationKey", "technicalSupplierNumber", "name", "displayName"]}}}}}}}}, "\/psu\/{psuId}\/avanza-applications" : {"post" : {"operationId" : "psupsuIdavanzaapplicationspost", "security" : [{"Bearer" : []}], "tags" : ["Avanza"], "summary" : "Avanza savings application", "description" : "Sends an email to Avanza telling them that the current user is interested in their savings program.\n\n Note that we already have the organization key and organization name in our database; the main reason we want the user to submit them is as a matter of record.", "parameters" : [{"$ref" : "#\/components\/parameters\/psuId"}, {"$ref" : "#\/components\/parameters\/Authorization"}, {"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "requestBody" : {"content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"contactPerson" : {"type" : "string", "examples" : ["Test Testsson"]}, "email" : {"type" : "string", "examples" : ["testy@noreply.com"]}, "organizationKey" : {"type" : "string", "examples" : ["165520010009"], "pattern" : "^[1-9][0-9]{11}$"}, "organizationName" : {"type" : "string", "examples" : ["Testbolaget AB"]}, "phoneNumber" : {"type" : "string", "examples" : ["+46712345678"]}}, "required" : ["organizationKey", "organizationName", "contactPerson", "phoneNumber", "email"]}}}}, "responses" : {"204" : {"description" : "NoContent", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}, "400" : {"description" : "BadRequest", "headers" : {"X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {}}}}}, "\/client-minimum-version" : {"get" : {"operationId" : "clientminimumversionget", "tags" : ["Miscellaneous "], "summary" : "Get the minimum required version for this client application", "description" : "Returns the minimum required version for the client application specified in the header 'X-Svea-ClientApp'", "parameters" : [{"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"clientName" : {"type" : "string", "examples" : ["TENANT-IOS"]}, "minVersion" : {"type" : "string", "examples" : ["1.99.0"]}}, "required" : ["clientName", "minVersion"]}}}}}}}, "\/banner" : {"get" : {"operationId" : "bannerget", "tags" : ["Miscellaneous "], "summary" : "Get a list of active banners", "description" : "Returns a list of active banners that the client can choose to show to the end user", "parameters" : [{"$ref" : "#\/components\/parameters\/X-Svea-ClientApp"}, {"$ref" : "#\/components\/parameters\/X-Svea-CorrelationId"}, {"$ref" : "#\/components\/parameters\/X-Svea-SessionId"}], "responses" : {"200" : {"description" : "OK", "headers" : {"Content-Type" : {"schema" : {"type" : "string"}, "example" : "application\/json"}, "X-Svea-CorrelationId" : {"schema" : {"type" : "string"}, "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes.", "example" : "21436a05-d62d-4f29-a253-31b3815d148b"}, "X-Svea-SessionId" : {"schema" : {"type" : "string"}, "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes.", "example" : "afe56332-dee2-48b4-ae0b-d694a6174a7e"}}, "content" : {"application\/json" : {"schema" : {"type" : "object", "properties" : {"banner" : {"type" : "array", "items" : {"type" : "object", "properties" : {"bannerId" : {"type" : "string", "format" : "uuid"}, "bannerType" : {"type" : "string", "examples" : ["alert"], "enum" : ["alert", "information", "survey", "promotion"], "description" : "**Note!** New bannerTypes might be added at any time and should be displayed as '*information*' if the client does not know how to handle them."}, "icon" : {"type" : ["string", "null"]}, "link" : {"type" : ["string", "null"]}, "platform" : {"type" : ["string", "null"], "enum" : ["Web", "iOS", "Android"], "description" : "If the banner only should be shown on a certain platform"}, "psuTypeFilter" : {"type" : ["array", "null"], "items" : {"type" : "string", "examples" : ["person"], "enum" : ["person", "organization", "foreignOrganization"]}}, "text" : {"type" : "string", "examples" : ["Just nu upplever vi driftstörningar, felsökning pågår"]}, "title" : {"type" : "string", "examples" : ["Driftstörning"]}}, "required" : ["bannerId", "bannerType", "psuTypeFilter", "platform", "title", "text", "icon", "link"]}}}, "required" : ["banner"]}}}}}}}}, "components" : {"schemas" : {"AccountAccessCapability" : {"title" : "AccountAccessCapability", "type" : "object", "properties" : {"accessType" : {"type" : "string", "examples" : ["accountAccess"], "enum" : ["accountAccess"]}, "accountAccessLevel" : {"type" : "string", "examples" : ["read"], "enum" : ["read", "preparePayment", "approvePayment"]}, "bankAccountId" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"]}}, "required" : ["accessType", "bankAccountId", "accountAccessLevel"]}, "ReportAccept-LanguageHeaderSchema" : {"title" : "ReportAccept-LanguageHeaderSchema", "type" : "string", "examples" : ["sv-SE"], "description" : "Determines delimiter and decimal symbols."}, "ReportAcceptHeaderSchema" : {"title" : "ReportAcceptHeaderSchema", "type" : "string", "examples" : ["text\/csv"], "enum" : ["text\/csv"]}, "accountTransactionFrom" : {"title" : "accountTransactionFrom", "type" : "string", "examples" : ["2018-01-01"]}, "accountTransactionTo" : {"title" : "accountTransactionTo", "type" : "string", "examples" : ["2020-12-31"]}, "annualStatement" : {"title" : "annualStatement", "type" : ["object", "null"], "properties" : {}}, "authorizationsPageSize" : {"title" : "authorizationsPageSize", "type" : "integer", "examples" : [100]}, "bankMessage" : {"title" : "bankMessage", "type" : ["object", "null"], "properties" : {}}, "cardauthorizationsPageSize" : {"title" : "cardauthorizationsPageSize", "type" : "integer", "examples" : [100]}, "cardtransactionsPageSize" : {"title" : "cardtransactionsPageSize", "type" : "integer", "examples" : [100]}, "filterAmountFrom" : {"title" : "filterAmountFrom", "type" : "string", "examples" : ["123.50"]}, "filterAmountTo" : {"title" : "filterAmountTo", "type" : "string", "examples" : ["123.50"]}, "filterDescription" : {"title" : "filterDescription", "type" : "string", "examples" : ["BM 0007"], "pattern" : "^[\\w\\s-\\.,]{1,50}$", "maxLength" : 50}, "incomingAutogiroNotification" : {"title" : "incomingAutogiroNotification", "type" : "object", "properties" : {"link" : {"type" : "string", "examples" : ["http:\/\/someurl.com\/invoices\/1.pdf"]}, "unsignedTicket" : {"type" : "string", "examples" : ["TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="]}}, "required" : ["link", "unsignedTicket"]}, "incomingCreditNotification" : {"title" : "incomingCreditNotification", "type" : "object", "properties" : {"link" : {"type" : "string", "examples" : ["http:\/\/someurl.com\/invoices\/1.pdf"]}, "unsignedTicket" : {"type" : "string", "examples" : ["TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="]}}, "required" : ["link", "unsignedTicket"]}, "incomingEDocument" : {"title" : "incomingEDocument", "type" : "object", "properties" : {"link" : {"type" : "string", "examples" : ["http:\/\/someurl.com\/invoices\/1.pdf"]}, "unsignedTicket" : {"type" : "string", "examples" : ["TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="]}}, "required" : ["link", "unsignedTicket"]}, "incomingEinvoice" : {"title" : "incomingEinvoice", "type" : "object", "properties" : {"link" : {"type" : "string", "examples" : ["http:\/\/someurl.com\/invoices\/1.pdf"]}, "unsignedTicket" : {"type" : "string", "examples" : ["TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="]}}, "required" : ["link", "unsignedTicket"]}, "reservationPage" : {"title" : "reservationPage", "type" : "integer", "examples" : [1]}, "reservationPageSize" : {"title" : "reservationPageSize", "type" : "integer", "examples" : [100]}, "transactionsPageSize" : {"title" : "transactionsPageSize", "type" : "integer", "examples" : [100]}}, "parameters" : {"Accept" : {"name" : "Accept", "in" : "header", "schema" : {"type" : ["string", "null"], "examples" : ["application\/json"], "enum" : ["application\/json", "text\/csv"], "default" : "application\/json", "description" : "Determines the format of the result"}}, "Accept-Language" : {"name" : "Accept-Language", "in" : "header", "schema" : {"type" : "string", "examples" : ["sv-SE"], "description" : "Determines delimiter and decimal symbols."}}, "Authorization" : {"name" : "Authorization", "in" : "header", "schema" : {"type" : "string", "examples" : ["Bearer {BearerToken}"]}, "required" : true}, "ReportAccept-LanguageHeaderSchema" : {"name" : "Accept-Language", "in" : "header", "schema" : {"$ref" : "#\/components\/schemas\/ReportAccept-LanguageHeaderSchema"}}, "ReportAcceptHeaderSchema" : {"name" : "Accept", "in" : "header", "schema" : {"$ref" : "#\/components\/schemas\/ReportAcceptHeaderSchema"}}, "X-Svea-ClientApp" : {"name" : "X-Svea-ClientApp", "in" : "header", "schema" : {"type" : "string", "examples" : ["TENANT-IOS\/0.99.0"], "pattern" : "^(?'name'\\S+?)\\s*\\\/\\s*(?'version'\\S*)\\s*(?'comment'\\S.*)?$", "description" : "Tenant client app name, version, and optional comment \\<client-app-name\\>\/\\<version\\>(\/\\<comment\\>)"}, "required" : true}, "X-Svea-CorrelationId" : {"name" : "X-Svea-CorrelationId", "in" : "header", "schema" : {"type" : "string", "examples" : ["21436a05-d62d-4f29-a253-31b3815d148b"], "format" : "uuid", "description" : "The correlationId is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. Used to follow transaction information, especially for logging purposes."}}, "X-Svea-SessionId" : {"name" : "X-Svea-SessionId", "in" : "header", "schema" : {"type" : "string", "examples" : ["afe56332-dee2-48b4-ae0b-d694a6174a7e"], "format" : "uuid", "description" : "The sessionId is a unique identifier value for a users session. This identifier should be the same for the entire duration of that users session. Mainly used for logging and troubleshooting purposes."}}, "accountTransactionFrom" : {"name" : "from", "in" : "query", "description" : "Filter out transactions before given date. Inclusive.", "schema" : {"$ref" : "#\/components\/schemas\/accountTransactionFrom"}, "required" : false}, "accountTransactionTo" : {"name" : "to", "in" : "query", "description" : "Filter out transactions after given date. Inclusive.", "schema" : {"$ref" : "#\/components\/schemas\/accountTransactionTo"}, "required" : false}, "attachmentId" : {"name" : "attachmentId", "in" : "path", "schema" : {"type" : "string", "examples" : ["3ea6b4d9-3cf8-4f8b-81e8-8c8479a7285c"], "format" : "uuid"}, "required" : true}, "authorizationsPageSize" : {"name" : "pageSize", "in" : "query", "description" : "Set the number of authorizations to return per page. Min 1, Max 100", "schema" : {"$ref" : "#\/components\/schemas\/authorizationsPageSize"}, "required" : false}, "bankAccountId" : {"name" : "bankAccountId", "in" : "path", "schema" : {"type" : "string", "examples" : ["ccf7c77a-8e32-4d9b-8f40-ea446f37d492"], "format" : "uuid"}, "required" : true}, "bgPgNumber" : {"name" : "bgPgNumber", "in" : "query", "schema" : {"type" : "string", "examples" : ["5395-9821"]}}, "cardId" : {"name" : "cardId", "in" : "path", "schema" : {"type" : "string", "examples" : ["46d83b79-27d4-4039-95ad-6ba25c1627ce"], "format" : "uuid"}, "required" : true}, "cardauthorizationsPageSize" : {"name" : "pageSize", "in" : "query", "description" : "Set the number of authorizations to return per page. Min 1, Max 100", "schema" : {"$ref" : "#\/components\/schemas\/cardauthorizationsPageSize"}, "required" : false}, "cardtransactionsPageSize" : {"name" : "pageSize", "in" : "query", "description" : "Set the number of transactions to return per page. Min 1, Max 100", "schema" : {"$ref" : "#\/components\/schemas\/cardtransactionsPageSize"}, "required" : false}, "creditorId" : {"name" : "creditorId", "in" : "path", "schema" : {"type" : "string", "examples" : ["74a136b1-70f5-4c18-bfdd-4d3945ca1e3f"], "format" : "uuid"}, "required" : true}, "delegateId" : {"name" : "delegateId", "in" : "path", "schema" : {"type" : "string", "examples" : ["7aa2dfea-2b0c-45cb-8f03-4743c284417d"], "format" : "uuid"}, "required" : true}, "enrollmentId" : {"name" : "enrollmentId", "in" : "path", "schema" : {"type" : "string", "examples" : ["9551114d-be0b-4afd-9f44-6b0d76851e88"], "format" : "uuid"}, "required" : true}, "filterAmountFrom" : {"name" : "amountFrom", "in" : "query", "description" : "Return only transactions greater than or equal to the given amount. Supports positive and negative amounts.", "schema" : {"$ref" : "#\/components\/schemas\/filterAmountFrom"}, "required" : false}, "filterAmountTo" : {"name" : "amountTo", "in" : "query", "description" : "Return only transactions lesser than or equal to the given amount. Supports positive and negative amounts.", "schema" : {"$ref" : "#\/components\/schemas\/filterAmountTo"}, "required" : false}, "filterDescription" : {"name" : "description", "in" : "query", "description" : "Return only transactions with a description containing the given string.", "schema" : {"$ref" : "#\/components\/schemas\/filterDescription"}, "required" : false}, "from" : {"name" : "from", "in" : "query", "description" : "Set the minimum date for returned transactions", "schema" : {"type" : "string", "examples" : ["2025-08-01"]}, "required" : false}, "loanAccountId" : {"name" : "loanAccountId", "in" : "path", "schema" : {"type" : "string", "examples" : ["8c6e0ed6-1192-48e6-8439-09821533cb31"], "format" : "uuid"}, "required" : true}, "messageId" : {"name" : "messageId", "in" : "path", "schema" : {"type" : "string", "examples" : ["cd3140f5-c5ff-4446-9dda-c6d4e9fec2c0"], "format" : "uuid"}, "required" : true}, "page" : {"name" : "page", "in" : "query", "description" : "Set which page to return (1 indexed), will default to 1 if not set. Min 1", "schema" : {"type" : "integer", "examples" : [1]}, "required" : false}, "paymentOrderId" : {"name" : "paymentOrderId", "in" : "path", "schema" : {"type" : "string", "examples" : ["272a4d86-5465-447a-a1d6-b04705eef692"], "format" : "uuid"}, "required" : true}, "preregisteredAccountId" : {"name" : "preregisteredAccountId", "in" : "path", "schema" : {"type" : "string", "examples" : ["fe4cf362-f99f-41ee-af0b-90b012bbf5c6"], "format" : "uuid"}, "required" : true}, "preregisteredDebtorId" : {"name" : "preregisteredDebtorId", "in" : "path", "schema" : {"type" : "string", "examples" : ["45ca54fc-1d39-415d-9f93-ee0818a6bee3"], "format" : "uuid"}, "required" : true}, "psuId" : {"name" : "psuId", "in" : "path", "schema" : {"type" : "string", "examples" : ["febbe8f2-bd6b-4e53-89c6-e89ca92ff5ee"], "format" : "uuid"}, "required" : true}, "reservationPage" : {"name" : "page", "in" : "query", "description" : "Set which page of reservations to return (1 indexed), will return all reservations if not set. Min 1", "schema" : {"$ref" : "#\/components\/schemas\/reservationPage"}, "required" : false}, "reservationPageSize" : {"name" : "pageSize", "in" : "query", "description" : "Set the number of reservations to return per page, will return all reservations if not set. Min 1, Max 100", "schema" : {"$ref" : "#\/components\/schemas\/reservationPageSize"}, "required" : false}, "to" : {"name" : "to", "in" : "query", "description" : "Set the maximum date for returned transactions", "schema" : {"type" : "string", "examples" : ["2025-08-05"]}, "required" : false}, "transactionId" : {"name" : "transactionId", "in" : "path", "schema" : {"type" : "string", "examples" : ["2ac0c2e0-5b20-4906-ab33-fbca39607531"], "format" : "uuid"}, "required" : true}, "transactionsPageSize" : {"name" : "pageSize", "in" : "query", "description" : "Set the number of transactions to return per page, will default to 100 if not set. Min 1, Max 100", "schema" : {"$ref" : "#\/components\/schemas\/transactionsPageSize"}, "required" : false}, "type" : {"name" : "type", "in" : "query", "description" : "Type of saved Creditors to return", "schema" : {"type" : "string", "examples" : ["all"], "enum" : ["all", "bankGiro", "plusGiro", "swedishBankAccount"]}}}}}