Skip to main content
POST
/
api
/
v2
/
sessions
/
{sessionId}
/
guarantees
/
confirm
Confirm Guarantee
curl --request POST \
  --url https://www.{baseurl}.com/api/v2/sessions/{sessionId}/guarantees/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "guaranteeAccepted": true
}
'
{
  "sessionId": "86095db9-7cb4-4121-a6ca-9d64368c6463",
  "referenceId": "d858dd37-3e98-4e00-accc-5f54b1d8c369"
}
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 url configured. (please, ask 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.

​
Guaranteee Confirmation Behavior

If a webhook is configured for this event, after three unsuccessful attempt of delivery the event, the session automatically fails. If no webhook is configured, all emitted guarantee are always considered as auto accepted by the client.

​
Request Example

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

​
Response

{
    "sessionId": "86095db9-7cb4-4121-a6ca-9d64368c6463",
    "referenceId": "d858dd37-3e98-4e00-accc-5f54b1d8c369"
}

​
Response Fields

  • sessionId: Unique session identifier for the terminated session
  • 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"
}

Authorizations

​
Authorization
string
header
required

Bearer token obtained from /api/v1/authorize endpoint

Headers

​
Authorization
string
required

Bearer token received from /authorize endpoint.

Pattern: ^Bearer .+

Path Parameters

​
sessionId
string<uuid>
required

Unique session identifier obtained from session creation.

Body

application/json
​
guaranteeAccepted
boolean
required

true to accept the guarantee, false to reject it.

Example:

true

Response

Guarantee decision recorded successfully

​
sessionId
string<uuid>

Unique session identifier.

Example:

"86095db9-7cb4-4121-a6ca-9d64368c6463"

​
referenceId
string

Reference ID provided during session creation (if any).

Example:

"d858dd37-3e98-4e00-accc-5f54b1d8c369"