Get a Link for the User to Add a Card

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

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

Add Card

Get a ready-made web page link that lets one of your users add their own payment card. You show this page inside your own website (inside an iframe). The user types their card details on that page, and we store the card safely for them.

What you get back

user_id — the user this link is for.
add_card_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 card is added successfully, we send your server an automatic notification (a payment_method.card.added webhook) with the card 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 processes the card behind the scenes. Treat it as a plain string with no meaning of its own.

GET

/

v1

/

platform

/

card

/

add-card

/

{user_id}

Get a Link for the User to Add a Card

curl --request GET \
  --url https://api-sandbox.finogates.com/v1/platform/card/add-card/{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 card is being added for.

Example:

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

Query Parameters

card_processing_id

string<uuid> | null

Optional. Tie this card to one specific approved card-processing account (use the id returned by GET /v1/platform/card-processing/users/{user_id}). The card will then always be charged, captured, and refunded through that same account. Leave this out to use the user's default card-processing account.

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.

Get One Card's Details Remove Card