Get a Link for the User to Add a Bank Account

curl --request GET \
  --url https://api-sandbox.finogates.com/v1/platform/bank/add-account-instantly/{user_id} \
  --header 'Authorization: Bearer <token>'

{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

Add account Instantly

Get a ready-made web page link that lets one of your users add their own bank account. You show this page inside your own website (inside an iframe). The user connects their bank on that page, and we save the account for them automatically.

What you get back

user_id — the user this link is for.
add_bank_url — the link to load inside an iframe. It can be used once.
expires_at — the time the link stops working (about 10 minutes away).

How you find out the result

When the bank account is added successfully, we send your server an automatic notification (a payment_method.bank.added webhook) with the new account details and the user_id. This notification is the official way to know it worked.
If something goes wrong on the page (the link expired, was tampered with, or the details didn’t pass our checks), nothing is saved and no notification is sent. Simply call this endpoint again to get a fresh link — links cannot be renewed.

The link contains no details about which company connects the bank behind the scenes. Treat it as a plain string with no meaning of its own.

GET

/

v1

/

platform

/

bank

/

add-account-instantly

/

{user_id}

Get a Link for the User to Add a Bank Account

curl --request GET \
  --url https://api-sandbox.finogates.com/v1/platform/bank/add-account-instantly/{user_id} \
  --header 'Authorization: Bearer <token>'

{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

user_id

string<uuid>

required

The unique ID of the user the bank account is being added for.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

Query Parameters

parent_origin

string | null

Optional. The bare origin of the page that will embed the link in an iframe (e.g. https://app.example.com — scheme + host + optional port, no path). When provided, the page sends the outcome back to that exact window via a browser message so your app can react in place. Omit it when opening the link as a full page or popup.

Maximum string length: 255

Example:

"https://app.example.com"

Response

Successful Response

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code

integer

required

HTTP status code for the response.

data

any

required

Payload or error details.

query_generated_time

integer

required

UTC timestamp (milliseconds since epoch) when response was generated.

List Bank Accounts Remove Bank Account