Inbox

Get a single message

get/psu/{psuId}/delegate/{delegateId}/inbox-message/{messageId}

Request

  • Base URL: https://bankapidemo.svea.com
  • URL: https://bankapidemo.svea.com/psu/{psuId}/delegate/{delegateId}/inbox-message/{messageId}
  • Auth: Bearer (a scheme the document does not define)

Path parameters

psuIdstring uuid required
Example:febbe8f2-bd6b-4e53-89c6-e89ca92ff5ee
delegateIdstring uuid required
Example:7aa2dfea-2b0c-45cb-8f03-4743c284417d
messageIdstring uuid required
Example:cd3140f5-c5ff-4446-9dda-c6d4e9fec2c0

Headers

Authorizationstring required
Example:Bearer {BearerToken}
X-Svea-ClientAppstring required

Tenant client app name, version, and optional comment <client-app-name>/<version>(/<comment>)

Example:TENANT-IOS/0.99.0
X-Svea-CorrelationIdstring uuid

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-SessionIdstring uuid

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

Response

OK

bodystring markdown required

This field contains a markdown formatted string.

header1string required
header2string required
logotypeUrlstring required
messageContextType'bankMessage' | 'annualStatement' | 'incomingEinvoice' | 'incomingCreditNotification' | 'incomingAutogiroNotification' | 'incomingEDocument' required

bankMessage and annualStatement does not have a context and therefor messageContext will be null

messageIdstring uuid required
timeReadstring date-time nullable required
timeSentstring date-time required

Example response

{
  "attachments": [
    {
      "attachmentId": "2341cbf9-3f9e-4762-8599-866e5ee15ee0",
      "availableUntil": "2020-01-01T10:00:00Z",
      "contentType": "application/pdf",
      "filename": "document.pdf",
      "isAvailable": true
    }
  ],
  "body": "Here is your quarterly report",
  "header1": "Yearly Report",
  "header2": "Q3 2019",
  "logotypeUrl": "http://someurl.com",
  "messageContext": {
    "link": "http://someurl.com/invoices/1.pdf",
    "unsignedTicket": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
  },
  "messageContextType": "bankMessage",
  "messageId": "2341cbf9-3f9e-4762-8599-866e5ee15ee0",
  "timeRead": "2019-01-01T16:20:00Z",
  "timeSent": "2019-01-01T16:20:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.