Session Details

​

Get Session Details

​

Availability of Account Details

• Complete session information: All details from session creation
• Verified account details: Bank account information after user authentication
• Payment validation data: Information needed for transaction processing
• Identity verification results: User identity matching status

​

Request Example

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

​

Response Structure

{
  "sessionId": "aadd08f2-83ce-456d-84ed-c68cfed4ee7b",
  "referenceId": "USER12345",
  "status": "Completed",
  "amount": 500.00,
  "currency": "CAD",
  "type": "EFT",
  "direction": "DEBIT",
  "payor": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@example.com",
    "phone": "5551234567",
    "address": {
      "addressLine1": "123 Main Street",
      "city": "Toronto",
      "postalCode": "M5V3A8",
      "province": "ON",
      "country": "CA"
    },
    "account": {      
      "institutionCode": "014",
      "transitNumber": "58964",
      "accountNumber": "1234567",
      "accountLabel": "Account (****4567)"
    }
  },
  "payee": {
    "account": {
      "institutionCode": "999",
      "transitNumber": "30265",
      "accountNumber": "9876541",
      "accountLabel": "Settlement Account"
    }
  },  
  "created_at": "2024-03-15T10:00:00Z",
  "updated_at": "2024-03-15T15:45:00Z",
  "completed_at": "2024-03-15T15:45:00Z"
}

​

Response Fields

​

Session Information

• sessionId: Unique session identifier
• referenceId: Your internal reference ID
• status: Current session status
• amount: Payment amount (if set)
• currency: Payment currency
• type: Payment type (always “EFT” for GEFT)
• direction: Payment direction (always “DEBIT” for GEFT)

​

Payor Information

• Personal details: Name, email, phone, address as provided during session creation
• Verified account: Bank account information obtained after user authentication
• Identity verification: Results of name matching against bank account

​

Payee Information

• Account details: Destination account information
• Account label: Display label for the destination account

​

Guarantee Information

• Status: Guarantee approval status
• Approved at: Timestamp of guarantee approval
• Coverage: Type of guarantee coverage provided

​

Timestamps

• created_at: Session creation time
• updated_at: Last modification time
• completed_at: Completion time (if applicable)

​

Data Availability Timeline

​

Before User Authentication (Status: Initiated)

{
  "sessionId": "aadd08f2-83ce-456d-84ed-c68cfed4ee7b",
  "referenceId": "USER12345",
  "status": "Initiated",
  "payor": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@example.com",
    "verifiedAccount": null
  }
}

​

After User Authentication (Status: Completed/Failed)

{
  "sessionId": "aadd08f2-83ce-456d-84ed-c68cfed4ee7b",
  "status": "Completed",
  "payor": {
    "firstName": "John",
    "lastName": "Smith",
    "verifiedAccount": {
      "institutionName": "Royal Bank of Canada",
      "accountType": "checking",
      "accountNumber": "****1234",
      "transitNumber": "12345",
      "institutionCode": "003"
    }
  }
}

​

Use Cases

​

Payment Validation

• Verify user identity matches bank account holder
• Confirm account details for reconciliation
• Validate guarantee status before processing

​

Audit and Compliance

• Complete transaction trail for regulatory requirements
• Identity verification documentation
• Account verification records

​

Customer Support

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

​

Reconciliation

• Match payments to internal records using referenceId
• Account details for settlement verification
• Complete payment lifecycle information

​

Error Responses

​

Session Not Found

{
  "error": "not_found",
  "error_description": "Session not found"
}

​

Authentication Required

{
  "error": "unauthorized",
  "error_description": "Valid access token required"
}

​

Insufficient Permissions

{
  "error": "forbidden",
  "error_description": "Access denied to session details"
}

​

Security Considerations

​

Data Protection

• Account numbers: Masked for security (showing only last 4 digits)
• Personal information: Handle according to privacy regulations
• Access controls: Ensure proper authentication and authorization

​

Compliance

• Data retention: Follow regulatory requirements for payment data
• Audit trails: Maintain complete records for compliance
• Privacy: Protect customer personal and financial information

​

Best Practices

​

When to Call This Endpoint

• After status changes: When polling shows status updates
• For reconciliation: During end-of-day processing
• For support: When investigating payment issues
• For compliance: When audit trails are required

​

Data Handling

• Cache appropriately: Avoid excessive API calls
• Secure storage: Protect sensitive account information
• Access logging: Log all access to session details

​

Related Endpoints

• Create Session - Initialize GEFT payment session
• Get Session Status - Monitor payment progress
• Cancel Session - Terminate active session