Get a Link for the User to Pay by Card

curl --request POST \
  --url https://api-sandbox.finogates.com/v1/platform/card/payment-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 1,
  "currency": "USD",
  "card_processing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

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

Get a Link for the User to Pay by Card

Get a ready-made web page link that lets one of your users pay a fixed amount with their card. You show this page inside your own website (inside an iframe). The user enters their card on that page, taps Pay, and we charge the card.

What you need to send

user_id — the user who will pay.
amount — the amount to charge, in major units (e.g. 12.50).
currency — optional ISO currency code; defaults to USD.
card_processing_id — optional; pin the charge to one specific approved card-processing account.

What you get back

payment_intent_id — the recorded payment. It is created straight away in a pending state and shows up in your payment listings, so you can track or reconcile it. It becomes succeeded or failed once the user pays.
pay_url — the link to load inside an iframe. It can be used once.
expires_at — the time the link stops working (about 10 minutes).

How you find out the result

The user sees the outcome on the page itself. Your server is also notified by a payment_intent.succeeded or payment_intent.failed webhook carrying the payment_intent_id.

The page also offers the user a “save card for future use” choice; when they accept, the card is stored so they can reuse it later.

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.

POST

platform

card

payment-link

Get a Link for the User to Pay by Card

curl --request POST \
  --url https://api-sandbox.finogates.com/v1/platform/card/payment-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 1,
  "currency": "USD",
  "card_processing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "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.

Body

application/json

Request body for POST /v1/platform/card/payment-link.

Mints a one-time hosted card-payment page for the end user. The amount is recorded on the resulting payment record and is the authoritative figure charged — it is never re-read from the browser.

user_id

string<uuid>

required

The end-user who will pay. Must be an end_user belonging to the calling tenant.

amount

required

Amount to charge, in major units (e.g. 12.50).

Required range: x > 0

currency

string

default:USD

ISO-4217 currency code. Defaults to USD.

Required string length: 3

card_processing_id

string<uuid> | null

Optional. Pins the charge to a specific approved card-processing merchant account (the id returned by GET /v1/platform/card-processing/users/{user_id}). Omit to use the user's deterministically selected default merchant.

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.

Apply for Card Processing Get Card Processing Record(s)