GEFT API Overview

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.

​

Base URLs

​

Authentication

1. Authenticate with Basic auth using Client ID and Secret
2. Receive Bearer token valid for 599 seconds (10 minutes)
3. Use Bearer token for all subsequent API calls
4. Refresh token before expiration

​

API Endpoints

​

Authentication

​

Session Management

​

Quick Start

​

1. Authenticate

curl --location '{{BaseUri}}/api/v1/authorize' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic {{Username:Password}}' \
--data-urlencode 'grant_type=client_credentials'

​

2. Create Session

curl --location '{{BaseUri}}/api/v2/sessions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{access_token}}' \
--data-raw '{
  "referenceId": "USER12345",
  "type": "EFT",
  "direction": "DEBIT",
  "options": {
    "guarantee": {
      "enable": true
    }
  },
  "payor": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "addressLine1": "123 street",
      "city": "Toronto",
      "postalCode": "h2eh2e",
      "province": "ON",
      "country": "CA"
    }
  }
}'

​

3. Launch User Flow

<iframe
  src="{{BaseUri}}/app/?sessionId={{sessionId}}"
  width="100%"
  height="600">
</iframe>

​

4. Monitor Status

curl --location '{{BaseUri}}/api/v2/sessions/{{sessionId}}/status' \

​

Session Object

{
  "sessionId": "850750a4-3021-4061-ac03-a8d873aa4179",
  "referenceId": "USER12345",
  "amount": 500.00,
  "status": "Completed",
  "statusDetails": "EFT0301"
}

​

Status Codes

​

Session Status Values

​

Status Meanings

​

Field Specifications

​

Character Limits

​

Validation Rules

• Maximum: $99,999.99 (default)
• Minimum: Client-configurable
• Decimal places: Up to 2

• Only “CAD” supported

• AB (Alberta), BC (British Columbia), MB (Manitoba)
• NB (New Brunswick), NL (Newfoundland and Labrador)
• NT (Northwest Territories), NS (Nova Scotia), NU (Nunavut)
• ON (Ontario), PE (Prince Edward Island), QC (Quebec)
• SK (Saskatchewan), YT (Yukon)

• Numbers only
• No country codes, spaces, or special characters
• Example: “5551234567” (not “+1-555-123-4567”)

​

Payment Processing

​

EFT Processing Windows

​

Destination Account Logic

1. With payee object: Funds settle to specified account
2. Without payee object: Funds settle to your configured default account
3. No payee + no default: Request rejected with error

​

Payment Instructions

1. EFT credit from Flinks float account to your destination account
2. EFT debit from end-user’s account to Flinks float account

​

Frontend Integration

​

iFrame URL Pattern

{{BaseUri}}/app/?sessionId={{sessionId}}

​

Event Monitoring

window.addEventListener('message', function(e) {
  console.log('GEFT Event:', e.data);

  if (e.data.Step === 'SUCCESS') {
    // Payment completed successfully
  } else if (e.data.Step === 'GUARANTEE_FAILED') {
    // Guarantee declined, offer alternatives
  }
});

​

Error Handling

​

API Errors

{
  "error": "invalid_client",
  "error_description": "Invalid client credentials"
}

{
  "error": "invalid_request",
  "error_description": "Missing required field: firstName"
}

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

​

Common Integration Issues

1. Token Expiration: Access tokens expire after 599 seconds
2. Name Mismatch: User info must match bank account holder
3. Amount Limits: Respect min/max amount configurations
4. Character Limits: Validate field lengths before submission

​

Rate Limits

• Authentication: 60 requests per minute
• Session Creation: 100 requests per minute
• Status Queries: 1000 requests per minute

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1647360000

​

Testing

• Test Scenarios: Happy1, Happy2, Happy3, Unhappy1, Unhappy7, Unhappy8
• Credentials: Provided during onboarding
• Test Data: Predefined user profiles and expected outcomes

​

Support

• Contact your Technical Account Manager
• Reference session IDs and timestamps in support requests
• Include relevant API request/response data

• Setup Guide
• Event Handling
• Sandbox Guide

​

Next Steps

1. Authentication: Set up API authentication
2. Session Creation: Create and manage sessions
3. Setup Guide: Complete implementation walkthrough