---
title: "Create a payment link"
method: POST
path: "/v3/payment/payment-links"
tags: ["Payment links"]
---

# Create a payment link

`POST /v3/payment/payment-links`

Create a new payment link

## Request body

- object
  - `user` object, required — User who will initiate the payment
    - `first_name` string — Mandatory with lastname or only company_name (max 35 char : alphanumeric, space and some symbols + ( ) / . - ! ? , ; & % € are supported but it must contain at least one letter)
    - `last_name` string — Mandatory with firstname or only company_name (max 35 char : alphanumeric, space and some symbols + ( ) / . - ! ? , ; & % € are supported but it must contain at least one letter)
    - `company_name` string — Mandatory or firstname and last_name must be completed (max 35 char : alphanumeric, space and some symbols + ( ) / . - ! ? , ; & % € are supported but it must contain at least one letter)
    - `email` string — Mandatory depending on your use case
    - `external_reference` string — We recommend filling this value with a unique ID that identifies your user. It helps Bridge optimize fraud detection by tracking how many payments have been initiated by a single user within a specific period.
  - `expired_date` string, date-time — The link status will be set to "EXPIRED" after this date. Format is yyyy-MM-ddThh:mm:ssZ (ISO8601)
  - `client_reference` string — A reference to link this link to your system (100 char. max)
  - `transactions` object[], required — Details of the payment
    - `amount` number, float, required
    - `currency` 'EUR', required — Only EUR is supported for now
    - `end_to_end_id` EndToEndId — unresolved $ref
    - `client_reference` string — A reference to link this transaction to your system (100 char. max)
    - `execution_date` string, date — YYYY-MM-DD up to 60 days from today
    - `beneficiary` object — By default, the trusted beneficiary configured in the dashboard will be used Please contact us if you need to specify beneficiaries via the API
      - `iban` string, required — IBAN recipient
      - `first_name` string — Mandatory with lastname or only company_name (max 35 char : alphanumeric, space and some symbols + ( ) / . - ! ? , ; & % € are supported but it must contain at least one letter)
      - `last_name` string — Mandatory with firstname or only company_name (max 35 char : alphanumeric, space and some symbols + ( ) / . - ! ? , ; & % € are supported but it must contain at least one letter)
      - `company_name` string — Mandatory or firstname and last_name must be completed (max 35 char : alphanumeric, space and some symbols + ( ) / . - ! ? , ; & % € are supported but it must contain at least one letter)
      - `email` string — Mandatory depending on your use case
      - `virtual_iban_mode` string — If ondemand, the VIBAN will be created when the user decides to pay with a manual transfer. If auto, the VIBAN is automatically created and available in the API answer.
      - `virtual_iban_id` string — Let you reuse an existing VIBAN
  - `callback_url` string, url — If you want to redirect the users to your interface instead of Bridge's interface after they completed the journey from their bank website or application
  - `country` 'fr' | 'es' | 'de' | 'gb' — To define the default banks displayed in the banks list. If not defined, french banks will be displayed.
  - `provider_id` integer — If the parameter is set, your user won't see the providers list. Be careful to select providers with at least the single_payment capability
  - `sender_iban` string — The IBAN which will be debited for providers that support it, otherwise this setting will be ignored

## Response `200`

Payment link creation response

- object
  - `id` string — The created payment link's unique identifier
  - `url` string — The url to go to initiate the payment

---

[API](https://skmtc.dev/bridgeapi/apis/bridge-api.md) · [All operations](https://skmtc.dev/bridgeapi/apis/bridge-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bridgeapi/bridge-api/revisions/9b9ad8010fd5/schema)