Saltar al contenido principal
POST
Crear enlace de pago

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido

Cuerpo

application/json
account_id
string
requerido

El identificador único de la cuenta. Encuentras esta información en el Dashboard de Yuno (MAX 64; MIN 36).

country
enum<string>
requerido

El código de país del cliente (MAX 2; MIN 2; ISO 3166-1) [Obligatorio].

Opciones disponibles:
AR,
BO,
BR,
CL,
CO,
CR,
EC,
SV,
GT,
HN,
MX,
NI,
PA,
PY,
PE,
US,
UY
amount
object
requerido

Indica el objeto del monto del pago, con el valor y la moneda.

payment_method_types
string[]
requerido

La lista de tipos de métodos de pago que los clientes pueden usar. Consulta los métodos de pago disponibles en Tipo de pago. Si no se pasa ningún valor, Yuno mostrará los métodos de pago definidos en el Dashboard.

description
string

La descripción del enlace de pago (MAX 255; MIN 3).

merchant_order_id
string

Identificación de la transacción del enlace de pago definida por el comercio (MAX 255; MIN 3).

capture
boolean

Decide si se autoriza el pago o se captura. Autorizar un pago con tarjeta te permite reservar fondos en la cuenta bancaria de un cliente. Si no se define, el valor predeterminado es true.

type
string

El tipo de enlace de pago.

status
string

El estado del enlace de pago.

payment_method
object

Objeto del método de pago (opcional).

installments_plan
object

Configuración del plan de cuotas (opcional).

timezone
string

Zona horaria de disponibilidad (por ejemplo, UTC +03:00).

payments_number
integer

Número de pagos asociados con este enlace.

split_payment_methods
boolean

Permitir métodos de pago divididos.

taxes
object[]

Especifica la lista de impuestos del pago.

external_invoice
object

La factura de Stripe que paga este enlace de pago. Cuando el cliente paga, Yuno revisa la factura: debe estar abierta, el monto del enlace debe ser igual al monto restante de la factura, en la misma moneda, y el cliente debe ser el de la factura cuando se envía customer_id. Si la revisión falla, no se cobra nada y el enlace se cancela. No se puede enviar junto con subscription ni con una lista taxes que no esté vacía (400 INVALID_REQUEST) y no se puede cambiar después de la creación. Consulta Pagar una factura de Stripe (recargas).

customer_payer
object

Indica el objeto customer de los pagos.

additional_data
object

Indica el objeto additional_data. Este objeto no es obligatorio. Sin embargo, si envías esta información, la experiencia de pago de tu usuario mejora.

callback_url
string

URL a la que se redirige al cliente después del pago (MAX 256).

one_time_use
boolean

true permite un solo uso, false permite varios pagos

availability
object

El objeto de disponibilidad. Se refiere a la fecha de vencimiento del enlace de pago.

metadata
object[]

Especifica una lista de objetos de metadatos. Puedes agregar hasta 50 objetos de metadatos.

vault_on_success
boolean

Indicador para inscribir la tarjeta después de un pago exitoso

Respuesta

201

id
string
Ejemplo:

"555933df-4eed-4af4-ae83-a32072ef34af"

country
string
Ejemplo:

"US"

availability
object
status
string
Ejemplo:

"CREATED"

merchant_order_id
string
Ejemplo:

"AA01"

description
string
Ejemplo:

"Test"

amount
object
capture
boolean
predeterminado:true
Ejemplo:

true

metadata
any
split_payment_methods
boolean
predeterminado:true
Ejemplo:

false

payment_method_types
string[]
one_time_use
boolean
predeterminado:true
Ejemplo:

false

payments
any
callback_url
string
Ejemplo:

"https://checkout.sandbox.y.uno/payment/status"

installments_plan
any
customer_payer
any
taxes
any
external_invoice
object

La factura de Stripe que paga este enlace de pago, tal como se envió cuando se creó el enlace. La clave está ausente en los enlaces creados sin ella.

additional_data
object
account_id
string
Ejemplo:

"493e9374-510a-4201-9e09-de669d75f256"

checkout_url
string
Ejemplo:

"https://checkout.sandbox.y.uno/payment?session=2f6d9754-43d0-4dca-b023-6aba4b107179"

payments_number
integer
predeterminado:0
Ejemplo:

0

merchant_image
string
Ejemplo:

""