Finqware

Getting started

Changelog

Security

Overview

How-to

Create Link

Get Link

List Links

List Providers

Get Provider

Callback redirect

Link API - Alpha

Finqware Link API

FinqLink

Sandbox

Production

<h3 class="slate-h3 " >Overview</h3><p class="slate-p " ><code class="slate-code">Pay-by-link</code> is a method that breaks the payment process in two distinct phases:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">the creation of a payment request, operated by the creditor (receiver of funds)</div></li><li class="slate-li " ><div style="position:relative">the acceptance & authorization of the payment, operated by the debtor (the source of funds)</div></li></ul><p class="slate-p " >The payment request encapsulates metadata such as: amount, currency, the list of goods to be acquired etc. Once its created, the payment request is wrapped into a transportable object - aka <code class="slate-code">the link</code>- such as a URL or a QR code. The link is sent to a debtor who will only check/approve & authorize the payment.</p><p class="slate-p " >FinqLink is a <span style="color:rgb(0, 0, 0)">platform for developing pay-by-link applications</span>, built on top of the Finqware Payments API. <span style="color:rgb(0, 0, 0)">It comes with a simple API for generating payment links and a web application for operating the links. </span></p><h3 class="slate-h3 " >Payment providers</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">A <code class="slate-code">payment-provider</code> is a partner institution that operates payments. FinqLink integrates with these providers over APIs such as open-banking payment initiation APIs. </div></li><li class="slate-li " ><div style="position:relative">Each provider has a unique code. Eg: <code class="slate-code">rzb_ro</code>, <code class="slate-code">cec_ro</code> etc.</div></li><li class="slate-li " ><div style="position:relative">A provider may have one or multiple <code class="slate-code">payment-methods</code> offering different capabilities (domestic-only transfers, corporate-only transfers etc)</div></li></ul><h3 class="slate-h3 " >How to test</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Get a set of API test credentials (contact Finqware)</div></li><li class="slate-li " ><div style="position:relative">Use the <code class="slate-code">/providers/list</code> endpoint to query for the available/supported payment providers.</div></li><li class="slate-li " ><div style="position:relative">Create a payment link using the <code class="slate-code">/links/create</code> endpoint. The <code class="slate-code">payment-method</code> will be used to restrict more or less the options shown to the end-user when opening the payment link. </div></li><li class="slate-li " ><div style="position:relative">Send the payment link to someone in order to operate the payment.</div></li></ol><h3 class="slate-h3 " >Sandbox testing</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">rzb_ro</code> - debtor IBAN: <code class="slate-code">RO03RZBR0000069999999999</code>, creditor IBAN: <code class="slate-code">RO10RZBR0000069999999970</code>, PSU ID: <code class="slate-code">9999999998</code></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Test scenarios: (1) submit the debtor IBAN and/or PSU ID via the API; (2) do not submit them, let the user do the input</div></li></ul></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">bt_ro</code> - username: <code class="slate-code">testbt</code>, password: <code class="slate-code">testbt</code>, pin: <code class="slate-code">1234567</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">cec_ro</code> - username: <code class="slate-code">testcecapi</code>, password: <code class="slate-code">testcecapi</code>, IBAN: <code class="slate-code">RO42CECEAG0202RON0007466</code></div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

 is a method that breaks the payment process in two distinct phases:

The payment request encapsulates metadata such as: amount, currency, the list of goods to be acquired etc. Once its created, the payment request is wrapped into a transportable object - aka 

- such as a URL or a QR code. The link is sent to a debtor who will only check/approve & authorize the payment.

platform for developing pay-by-link applications

, built on top of the Finqware Payments API. 

It comes with a simple API for generating payment links and a web application for operating the links. 

<h4 class="slate-h4"><span style="color:rgb(0, 0, 0)" class="slate-color">[16.05.2024]</span></h4><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:13px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:13px" class="slate-backgroundColor">added the </span></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:13px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:13px" class="slate-backgroundColor"><code style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:13px" class="slate-code">prod</code></span></span><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:13px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(56, 67, 91);font-size:13px" class="slate-backgroundColor"> payment methods for: </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">first_ro</code></span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">, </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">vista_ro</code></span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">, </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">libra_ro</code></span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">, </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">exim_ro</code></span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">, </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">revolut_ro</code></span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">, </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">intesa_ro</code></span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">, </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">patria_ro</code></span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">, </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">otp_ro</code></span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">, </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">garanti_ro</code></span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">, </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">brd_ro</code></span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">, </span></span><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-code">alpha_ro</code></span></span></div></li><li class="slate-li"><div style="position:relative"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-color"><span style="background-color:rgb(248, 249, 251);color:rgb(31, 37, 50);font-size:14px" class="slate-backgroundColor">17 domestic (Romania) payment methods are now supported for stage/testing (max 5 RON per transaction) </span></span></div></li></ul><div style="text-align:left"> <img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/33635695-71bf-4631-b5c5-94b2748a8ff7.jpg" alt="" style="aspect-ratio:400 / 400" width="400" height="400"/></div><h4 class="slate-h4"><span style="color:rgb(0, 0, 0)" class="slate-color"></span></h4><p class="slate-p" placeholder="Type / for widgets"></p>

FinqLink API is secured by OAuth2 and mTLS

<p class="slate-p " >Create a new payment link.</p><p class="slate-p " >There are three flows currently supported (set via options/type):</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">link</code>: a standard transportable payment link. Offers maximum flexibility in terms of expiration and user optionality. Use this flow when generating payment links expected to be operated after a longer time. Example: an invoice sent over email which you don&apos;t expect an immediate action for.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">wrapped_sca</code>: a transportable payment link for immediate usage. The authorisation URL is requested at link creation, hence there is no optionality anymore for the user to choose a different payment provider. Use this flow when (1) you know upfront all the payment details and (2) you expect immediate action from your user, as the authorisation URL may expire in minutes.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">direct_sca</code>: a non-transportable payment link. This is a native authorisation URL received from the payment provider. Only available to regulated companies under PSD2 (PISP). </div></li></ul><p class="slate-p " ></p>

There are three flows currently supported (set via options/type):

client_id

A secret used for authenticating & authorising your client app. Not required for OAuth2-enabled clients.

client_secret

options

A set of filters for restricting payment-methods.

payment_method

single_transfer

Content-Type

Required for OAuth2-enabled clients (mandatory for production)

Authorization

request_id

created_at

expires_at

link_id

web_id

The name of the client app that generated the link.

api_client_app

web_url

qr_code

error_id

code

message

<p class="slate-p" placeholder="Type / for widgets">Retrieve information on an existing payment link.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieve information on an existing payment link.

The ID of the link to retrieve. This is a required parameter and should be a unique identifier for the link

is_expired

An id associated to the API request, for debugging purposes.

status

A user-facing web endpoint for operating the payment link.

<p class="slate-p " >List the links owned by an application identified by the client_id.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

List the links owned by an application identified by the client_id.

A list of links owned by the registered app identified by client_id.

links

<p class="slate-p " >List the supported payment-providers.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Filter for a specific list of service providers and their details.

filter

Options for showing service provider details

providers

<p class="slate-p " >Details on a particular payment-provider</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

provider_id

Please check the 'options' field from the /providers/list endpoint.

provider

<p class="slate-p " >A redirect endpoint used for <code class="slate-code">direct_sca</code> flows only (available only to PIS-regulated entities).</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

 flows only (available only to PIS-regulated entities).

The query string received from the bank via redirect.

query_string

If true, the request will await for a final status from the service provider, attempted by our backend in a background process.