Skip to main content
POST
Créer un lien
Essayez avec une clé sandbox (mp_sandbox_…) : aucun argent réel ne bouge. Voir Test et production.
Un fichier envoyé par un payeur (champ file) n’accepte que les images et les PDF. Il reste privé : seuls les membres de votre boutique l’ouvrent, depuis le détail du lien dans le tableau de bord. Voir Créer un lien par l’API pour des exemples de chaque mode de prix.

Authorizations

Authorization
string
header
required

Votre clé API. Utilisez une clé sandbox (mp_sandbox_…) pour essayer : aucun argent réel ne bouge.

Headers

Idempotency-Key
string

Une clé unique par opération : la rejouer pendant 24 heures renvoie la même réponse sans rien créer de plus. Voir Idempotence.

Maximum string length: 255

Body

application/json
title
string
required

Titre affiché au client

Maximum string length: 255
description
string

Description

Maximum string length: 500
pricing_mode
enum<string>

Sans valeur : fixed si amount est fourni, sinon flexible.

Available options:
fixed,
flexible,
options,
cart
amount
integer

Obligatoire en fixed. Prix en unités mineures.

Required range: 1 <= x <= 1000000000
minimum_amount
integer

Montant libre : minimum accepté

Required range: x >= 1
price_options
object[]

Obligatoire en options. Un tarif par élément.

items
object[]

Obligatoire en cart. Un article par élément.

custom_fields_schema
object[]

Champs à remplir par le payeur. Renvoyés sous custom_fields.

collect_phone
boolean

Demande le téléphone du payeur

collect_address
boolean

Demande l'adresse du payeur

after_payment_message
string

Affiché après un paiement réussi

Maximum string length: 1000
max_uses
integer

Nombre de paiements au-delà duquel le lien s'arrête

Required range: x >= 1
expires_at
string<date-time>

Fin de validité, dans le futur

success_url
string<uri>

Retour après paiement réussi

Maximum string length: 2048
cancel_url
string<uri>

Retour si le client abandonne

Maximum string length: 2048
active
boolean

true par défaut. false : le lien n'accepte plus de paiement.

metadata
object | null

Vos données libres, renvoyées telles quelles. 50 clés maximum, valeurs de 500 caractères maximum.

type
enum<string>
default:one_time

one_time par défaut, ou recurring pour inscrire à un plan

Available options:
one_time,
recurring
currency
string

Devise par défaut de votre compte si absente. Code devise ISO 4217 de 3 lettres, par exemple XAF.

Required string length: 3
plan
string

Obligatoire en recurring : identifiant d'un plan actif (plan_…)

Response

Lien créé

data
object