Skip to main content
POST
Create a payment link

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

Idempotency-Key
string
requerido
Required string length: 8 - 255

Cuerpo

application/json

Create a SimplePay Payment Link. Charges exactly one manual amount or catalog line item. A merchant offering installments must explicitly choose whether it absorbs financing cost or passes it to the buyer. The buyer only selects a term at quote/pay. No Stripe params are accepted.

manual_amount
integer
requerido

Charge a manual amount in minor units. Mutually exclusive with catalog_line_item.

Rango requerido: x >= 1
catalog_line_item
object

Charge a Digital Catalog line item by snapshot. Mutually exclusive with manual_amount.

currency
string
predeterminado:mxn
Pattern: ^[a-zA-Z]{3}$
metadata
object
recipient_email
string<email>

Optional buyer email. SimplePay delivers the link and makes it visible in that verified buyer's pending-link inbox; plaintext email is not persisted in the inbox projection.

Required string length: 3 - 254
expires_at
string<date-time> | null

Optional future RFC 3339 expiry with an explicit timezone. The origin normalizes it to UTC.

payment_method_types
enum<string>[]
Minimum array length: 1
Opciones disponibles:
card,
oxxo,
spei
installment_options
object[]

Canonical merchant-selected card installment terms to offer. Requires card in payment_method_types and one installment_pricing choice.

Required array length: 1 - 6 elements
installment_pricing
object

Merchant-owned financing choice applied consistently to every offered term. absorb forbids buyer markup; pass_to_buyer may include a governed markup in basis points.

Respuesta

201 - application/json

The created SimplePay Payment Link, including its canonical public URL.

id
string<uuid>
requerido
object
any
requerido
public_id
string
requerido
Pattern: ^splink_[a-z0-9]{32}$
url
string<uri>
requerido
Pattern: ^https://link\.simplepay\.mx/splink_[a-z0-9]{32}$
status
enum<string>
requerido
Opciones disponibles:
active,
inactive,
archived,
paid
amount_source
enum<string>
requerido
Opciones disponibles:
manual_amount,
catalog_line_item
manual_amount
integer | null
requerido
currency
string
requerido
Pattern: ^[a-z]{3}$
catalog_line_item_snapshot
object | null
requerido
payment_method_types
enum<string>[]
requerido
Minimum array length: 1
Opciones disponibles:
card,
oxxo,
spei
installment_options
object[]
requerido

Canonical installment terms offered by the resource; empty when installments are not offered.

Maximum array length: 6
installment_plan
object | null
requerido

One SimplePay card-installment term. The merchant offers terms at resource creation; the buyer may only select one offered term at quote/pay.

checkout_session_ref
string | null
requerido
Pattern: ^spcs_[a-z0-9]{32}$
expires_at
string<date-time> | null
requerido

UTC expiry timestamp, or null when the link does not expire automatically.

revoked_at
string<date-time> | null
requerido

UTC merchant-revocation timestamp, or null while the link has not been revoked.

metadata
object
requerido
created_at
string<date-time>
requerido
updated_at
string<date-time>
requerido
installment_pricing
object

Merchant-owned financing choice applied consistently to every offered term. absorb forbids buyer markup; pass_to_buyer may include a governed markup in basis points.

Última modificación el 1 de septiembre de 2026