Confirm Guarantee Decision

The Guarantee Decision feature introduces a new step in the Guaranteed EFT flow, allowing clients to explicitly accept or reject a guarantee before completing a session. This provides better control and transparency in the payment guarantee process for the client. To successfully call this endpoint, you must have a valid access token from the /Authorize endpoint.

Implementation Notes

This endpoint should ideally be used in association with our webhook system. Once a new guarantee is emitted, the system sends a webhook event to the configured url. Contact your Flinks representative for more details. Once the event is propagated to your system, you can then use this endpoint to share the decision on this session.

Guarantee Confirmation Behavior

If a webhook is configured for this event, after three unsuccessful attempts to deliver the event, the session automatically fails. If no webhook is configured, all emitted guarantees are always considered as auto accepted by the client.

The Guarantee Offer

Before calling this endpoint, the client receives a guarantee offer to review. It is delivered through the guarantee webhook event and is also available from Get Session Details in the guaranteeDetails object. The client evaluates this offer, then accepts or rejects it through this endpoint.

{
  "guaranteeDetails": {
    "guaranteeOffered": true,
    "guaranteeAccepted": null,
    "highestDebitAmountToGuarantee": 1500.00,
    "overallRiskLevel": "Medium",
    "transactionRiskLevel": "Low",
    "userRiskLevel": "Medium",
    "otherRiskLevel": "Low",
    "guaranteedEftType": "Full"
  },
  "userDetails": {
    "matchingPerformed": true,
    "nameMatch": 0.98
  },
  "referenceId": "USER1234",
  "amount": 2000.00,
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Guarantee Offer Fields

guaranteeOffered = whether a guarantee is being offered for this session
guaranteeAccepted = null until the client answers through this endpoint
highestDebitAmountToGuarantee = the maximum amount that can be guaranteed (for Partial or Minimal types this can be lower than the requested amount)
guaranteedEftType = one of Full, Partial, or Minimal
overallRiskLevel, transactionRiskLevel, userRiskLevel, otherRiskLevel = one of Unknown, Low, Medium, High, Low_Medium, or Medium_High
userDetails.matchingPerformed and userDetails.nameMatch = whether identity name-matching ran and the resulting match score

Request Example

curl --location '{{BaseUri}}/api/v2/sessions/{{sessionId}}/guarantees/confirm' \
--header 'Authorization: Bearer {{access_token}}' \
--request POST
--data-raw '
{
  "guaranteeAccepted": true
}'

Response

{
   "sessionId": "86095db9-7cb4-4121-a6ca-9d64368c6463",
   "referenceId": "USER1234"
}

Response Fields

sessionId: Unique identifier of the session the decision was applied to
referenceId: optional information given during the session initiation

Error Responses

Session Not Found

{
  "error": "not_found",
  "error_description": "No Session found for the reference {{sessionId}}"
}

Authentication Required

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

Create Session - Initialize GEFT payment session
Get Session Details - Retrieve comprehensive session information

API Reference

Auth

Connect

Enrich

Outbound

Pay

Upload

Utilities

Implementation Notes

Guarantee Confirmation Behavior

The Guarantee Offer

Guarantee Offer Fields

Request Example

Response

Response Fields

Error Responses

Session Not Found

Authentication Required

​Implementation Notes

​Guarantee Confirmation Behavior

​The Guarantee Offer

​Guarantee Offer Fields

​Request Example

​Response

​Response Fields

​Error Responses

​Session Not Found

​Authentication Required

​Related Endpoints

Implementation Notes

Guarantee Confirmation Behavior

The Guarantee Offer

Guarantee Offer Fields

Request Example

Response

Response Fields

Error Responses

Session Not Found

Authentication Required

Related Endpoints