Skip to main content
GET
/
api
/
v2
/
sessions
/
{sessionId}
/
details
curl --location '{{BaseUri}}/api/v2/sessions/{{sessionId}}/details' \
--header 'Authorization: Bearer {{access_token}}'

{
  "sessionId": "aadd08f2-83ce-456d-84ed-c68cfed4ee7b",
  "status": "Completed",
  "referenceId": "USER12345",
  "amount": 250.00,
  "type": "e-Transfer",
  "direction": "DEBIT",
  "currency": "CAD",
  "payor": {
    "email": "john.smith@example.com",
    "firstName": "John",
    "lastName": "Smith"
  },
  "payee": {
    "account": {
      "institutionCode": "999",
      "transitNumber": "30265",
      "accountNumber": "9876541"
    }
  },
  "schedule": {
    "transactions": [
      {
        "id": "f6e5d4c3-b2a1-0987-6543-21fedcba0987",
        "status": "Processed"
      }
    ]
  },
  "createdAt": "2026-04-23T12:43:59.203399Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.flinks.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve comprehensive information about an e-Transfer session, including the verified payor account once the user has authenticated. To successfully call this endpoint, you must have a valid access token from the /Authorize endpoint.

​
Get Session Details

Use this endpoint to retrieve the full session state: configuration, payor and payee information, identity matching results, and the current step in the flow. This endpoint provides:
  • Session information — all details from session creation

​
Response Structure

{
  "sessionId": "aadd08f2-83ce-456d-84ed-c68cfed4ee7b",
  "status": "Completed",
  "referenceId": "USER12345",
  "amount": 250.00,
  "type": "e-Transfer",
  "direction": "DEBIT",
  "currency": "CAD",
  "payor": {
    "email": "john.smith@example.com",
    "firstName": "John",
    "lastName": "Smith"
  },
  "payee": {
    "account": {
      "institutionCode": "999",
      "transitNumber": "30265",
      "accountNumber": "9876541",
    }
  },
  "schedule": {
    "transactions": [
      {
        "id": "f6e5d4c3-b2a1-0987-6543-21fedcba0987",
        "status": "Processed"
      }
    ]
  },
  "createdAt": "2026-04-23T12:43:59.203399Z"
}

curl --location '{{BaseUri}}/api/v2/sessions/{{sessionId}}/details' \
--header 'Authorization: Bearer {{access_token}}'

{
  "sessionId": "aadd08f2-83ce-456d-84ed-c68cfed4ee7b",
  "status": "Completed",
  "referenceId": "USER12345",
  "amount": 250.00,
  "type": "e-Transfer",
  "direction": "DEBIT",
  "currency": "CAD",
  "payor": {
    "email": "john.smith@example.com",
    "firstName": "John",
    "lastName": "Smith"
  },
  "payee": {
    "account": {
      "institutionCode": "999",
      "transitNumber": "30265",
      "accountNumber": "9876541"
    }
  },
  "schedule": {
    "transactions": [
      {
        "id": "f6e5d4c3-b2a1-0987-6543-21fedcba0987",
        "status": "Processed"
      }
    ]
  },
  "createdAt": "2026-04-23T12:43:59.203399Z"
}

​
Response Fields

​
Session Information

  • sessionId — unique session identifier
  • status — current session status (Initiated, Completed, Failed, Cancelled, Expired)
  • step — current step (current, aggregationRequestId, padId)
  • referenceId — your internal reference ID
  • amount — payment amount (null if not yet set)
  • type — payment type (e-Transfer or EFT)
  • direction — CREDIT or DEBIT
  • currency — always CAD
  • statusDetails — additional status context when applicable

​
Payor

  • Personal details — firstName, lastName, email as provided at session creation

​
Payee

  • Account details — destination account information (institutionCode, transitNumber, accountNumber)

​
Schedule

  • transactions — list of transactions associated with the session, each with id and status

​
Data Availability Timeline

​
Before User Authentication (Status: Initiated)

{
  "sessionId": "aadd08f2-83ce-456d-84ed-c68cfed4ee7b",
  "status": "Initiated",
  "amount": 250.00,
  "referenceId": "USER12345",
  "type": "e-Transfer",
  "direction": "DEBIT",
  "currency": "CAD",
  "payor": {
    "email": "john.smith@example.com",
    "firstName": "John",
    "lastName": "Smith"
  },
  "schedule": {
        "transactions": [
            {
                "id": "02a7aa91-810f-4de5-b33f-04a399291fd3",
                "status": "Processing"
            }
        ]
    },
    "createdAt": "2026-04-23T12:43:59.203399Z"
}

​
After User Authentication (Status: Completed)

{
  "sessionId": "aadd08f2-83ce-456d-84ed-c68cfed4ee7b",
  "status": "Completed",
  "amount": 250.00,
  "referenceId": "USER12345",
  "type": "e-Transfer",
  "direction": "DEBIT",
  "currency": "CAD",
  "payor": {
    "email": "john.smith@example.com",
    "firstName": "John",
    "lastName": "Smith"
  },
  "schedule": {
    "transactions": [
      {
        "id": "f6e5d4c3-b2a1-0987-6543-21fedcba0987",
        "status": "Processed"
      }
    ]
  },
  "createdAt": "2026-04-23T12:43:59.203399Z"
}

​
Use Cases

​
Payment Validation

  • Verify user identity matches bank account holder
  • Confirm account details for reconciliation

​
Audit and Compliance

  • Complete transaction trail for regulatory requirements
  • Identity verification documentation

​
Customer Support

  • Comprehensive session information for issue resolution
  • Complete payment history and status

​
Reconciliation

  • Match payments to internal records using referenceId
  • Account details for settlement verification

​
Error Responses

Error responses follow the RFC 7807 ProblemDetails format.

​
Bad Request

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid sessionId"
}

​
Unauthorized

{
  "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Valid access token required"
}

​
Forbidden

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
  "title": "Forbidden",
  "status": 403,
  "detail": "Access denied to session details"
}

Path Parameters

​
sessionId
string<uuid>
required

Response

Success

​
sessionId
string<uuid>
​
status
enum<string>
Available options:
Initiated,
Failed,
Cancelled,
Expired,
Completed
​
step
object
​
referenceId
string | null
​
amount
number<decimal> | null
​
type
enum<string>
Available options:
EFT,
e-Transfer
​
direction
enum<string>
Available options:
DEBIT,
CREDIT
​
currency
enum<string>
Available options:
CAD
​
options
object
​
payor
object
​
payee
object
​
guaranteeDetails
object
​
userDetails
object
​
statusDetails
string | null
​
schedule
object