Saltar al contenido principal
POST
Crear plan de cuotas
Yuno te permite crear planes de cuotas para ofrecer a tus clientes. Estos planes pueden usarse según factores como el monto a pagar, la moneda y la tarjeta utilizada, como se describe a continuación:
  • Filtrado por rango de montos (obligatorio): El sistema comprueba si el plan de cuotas es adecuado para el monto específico de tu transacción. Solo se consideran los planes que pueden manejar ese monto.
  • BIN de la tarjeta: El sistema verifica si el BIN de tu tarjeta coincide con los permitidos para ciertos planes de cuotas. Si hay coincidencia, ese plan se considera.
  • Moneda específica: Solo se consideran los planes que funcionan con la moneda que estás usando.
  • Disponibilidad del plan: El sistema comprueba si el plan de cuotas está activo. Solo se consideran los planes que no han expirado y están disponibles.
Definir el ID del planEl plan_id solo es necesario cuando se aplica un plan de cuotas fijo que no cambia durante la compra. Si no se envía installment.plan_id, el SDK buscará automáticamente entre todos los planes de cuotas disponibles asociados a esa cuenta y seleccionará el que considere más adecuado. Debes incluir el plan_id para asegurar que se aplique un plan específico.
Cuotas del comercioEste endpoint solo es necesario para la integración de cuotas del comercio. Para las cuotas definidas por el proveedor, usamos el plan de cuotas definido por tu proveedor de pagos.
Para las cuotas creadas por el comercio, también puedes especificar el plan para cada sesión de checkout usando el plan_id al crear la sesión. Si no lo envías, usaremos el plan de cuotas que coincida con las condiciones establecidas para la sesión de checkout.

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
name
string
requerido

El nombre del plan de cuotas (MAX 255; MIN 3)

account_id
string[]
requerido

El identificador único de la cuenta o cuentas que tendrán el plan de cuotas (UUID; 36 caracteres).

merchant_reference
string
requerido

Identificación del plan de cuotas (MAX 255; MIN 3)

installments_plan
object[]
requerido

Definición de las cuotas disponibles para cada escenario

country_code
string

El país del emisor (ISO 3166-1 MAX 2; MIN 2)

brand
string[]

Información de la marca de la tarjeta (MAX 255; MIN 3).

issuer
string

Emisor de la tarjeta (MAX 255; MIN 3)

iin
string[]

El número de identificación del emisor (IIN) corresponde a los primeros dígitos del número de una tarjeta de pago emitida por una institución financiera (MAX 8; MIN 6)

first_installment_deferral
integer<int32>

La cantidad de meses que se esperan para debitar la primera cuota (MAX: 3).

amount
object

Los montos para los que estará disponible el plan de cuotas. Si es null, está disponible para cualquier monto.

availability
object

Las fechas en las que estará disponible el plan de cuotas. Si es null, no tiene fecha de finalización

payment_method_type
enum<string>

Permite especificar el tipo de método de pago al crear un plan de cuotas. CARD coincide por el IIN de la tarjeta, mientras que NU_PAY_ENROLLMENT y APPLE_PAY coinciden sin él. Los planes solo se ofrecen al método de pago para el que se crearon.

Opciones disponibles:
CARD,
NU_PAY_ENROLLMENT,
APPLE_PAY

Respuesta

Hoy la respuesta devuelve amount.Currency con C mayúscula, no amount.currency. Lee la clave sin distinguir mayúsculas de minúsculas.

id
string
Ejemplo:

"4d573425-33f9-4c46-b009-2c7e749b0ec7"

name
string
Ejemplo:

"plan_007"

account_id
string[]
merchant_reference
string
Ejemplo:

"Test"

installments_plan
object[]
type
string
Ejemplo:

""

source
string
Ejemplo:

""

provider_id
string
Ejemplo:

""

scheme
string
Ejemplo:

""

brand
string[]
issuer
string
Ejemplo:

""

issuer_id
string
Ejemplo:

""

iin
any
country_code
string
Ejemplo:

"US"

first_installment_deferral
integer
predeterminado:0
Ejemplo:

0

amount
object
availability
object
created_at
string
Ejemplo:

"2023-10-11T17:52:31.886178246Z"

updated_at
string
Ejemplo:

"2023-10-11T17:52:31.886178246Z"

payment_method_type
enum<string>
Opciones disponibles:
CARD,
NU_PAY_ENROLLMENT,
APPLE_PAY
Ejemplo:

"NU_PAY_ENROLLMENT"