Skip to main content
POST
cURL
Create a hosted payment link. Returns a url the customer opens to pay with any card. Calculates tax, generates an invoice, and vaults the payment method on confirmation. No subscription or plan required.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
predeterminado:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Cuerpo

application/json
amount
integer
requerido
Rango requerido: x <= 9007199254740991
currency
string
requerido
Minimum string length: 1
description
string
requerido
Minimum string length: 1
customerId
string
Minimum string length: 1
successUrl
string<uri>
metadata
object

Respuesta

Success

paymentContext
object | null
requerido

Charge context captured for new payments. Null for historical payments with no captured context.

id
string
requerido
customerId
string | null
requerido
kind
enum<string>
requerido
Opciones disponibles:
link,
charge
status
enum<string>
requerido
Opciones disponibles:
pending,
processing,
succeeded,
requires_action,
failed,
canceled
provider
enum<string>
requerido
Opciones disponibles:
stripe,
commet,
dlocal
amountSubtotal
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
taxAmount
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
amountTotal
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
currency
string
requerido
description
string
requerido
metadata
object | null
requerido
url
string | null
requerido
expiresAt
string<date-time> | null
requerido
createdAt
string<date-time>
requerido
updatedAt
string<date-time>
requerido
object
string
requerido
Allowed value: "payment"
livemode
boolean
requerido