How G-EFT works
The Guaranteed EFT flow adds a guarantee step before the standard EFT process:- Session creation: Your server calls
/Authorizeand/Sessions/Initiateto create a payment session. - Customer authentication: The customer authenticates through Flinks Connect, selects their account, and specifies the payment amount.
- Guarantee issuance: Flinks analyzes the account and issues a payment guarantee (or refuses if risk is too high).
- Guarantee acceptance: You can explicitly accept or reject the guarantee, or configure auto-acceptance for low-risk guarantees.
- Payment processing: Once the guarantee is accepted, Flinks initiates the EFT and delivers funds to your settlement account.
Key features
| Feature | Description |
|---|---|
| Guarantee webhook | Receive a webhook notification when a guarantee is issued |
| Accept/reject | Explicitly accept or reject guarantees before completing the session |
| Auto-acceptance | Configure automatic acceptance for low-risk guarantees |
| Next Best Offer | Optionally receive an alternative amount suggestion if the requested amount can’t be guaranteed |
| Flexible settlement | Direct funds to your organization’s settlement account or individual user accounts |
| Session status webhook | Receive notifications when a session moves to failed, cancelled, or completed status |
| Payor details endpoint | Retrieve complete payor account details (institution code, transit number, account number) |
Setting up G-EFT
Prerequisites
- An active Flinks Pay instance with EFT enabled
- G-EFT feature enabled by your Flinks Representative
Integration flow
-
Authorize: Call the /Authorize endpoint to get an
access_token. -
Initiate session: Call
/Sessions/Initiatewith theaccess_tokento create a G-EFT session. -
Launch the application: Open the Flinks Pay application for the customer using your session URL:
- Handle guarantee: Listen for the guarantee webhook or poll the session status to determine if a guarantee was issued.
- Accept or reject: Use the guarantee details to accept or reject the payment.
-
Monitor settlement: Track the payment through to settlement using the
/PaymentRequestsGET endpoint or status webhooks.
Sandbox testing
To test G-EFT in the sandbox environment:- Use your sandbox credentials provided by Flinks during onboarding.
- Create a session using the test institution Flinks Capital.
- Authenticate with username
Greatdayand passwordEveryday. - Complete the payment flow and verify the guarantee webhook is received.
Webhook testing is not available in sandbox environments. To test webhooks with G-EFT, you’ll need to use your staging or production instance. Contact your Flinks Representative for staging access.