Saltar al contenido principal
POST
Esta solicitud inscribe un método de pago para un cliente. Con la información que Yuno proporciona después de que el cliente selecciona el método de pago a inscribir, podrás guardar esa información para compras futuras usando el objeto de método de pago creado. Consulta los métodos de pago disponibles en Yuno. Deberás configurar tus credenciales para cada método de pago en el dashboard de Yuno para poder usarlos. Ten en cuenta que esta solicitud requiere un X-Idempotency-Key. Consulta la página Authentication para más información.
WebhooksRecomendamos escuchar Webhooks para mantenerte al día con el estado de los métodos de pago inscritos de tus clientes.
Si un cliente inscribe la misma tarjeta varias veces, Yuno crea una nueva inscripción cada vez y devuelve un vaulted_token distinto. Usa el fingerprint de la tarjeta en la respuesta de la inscripción para detectar duplicados de tu lado (el fingerprint puede ser null para algunos proveedores). Consulta Card Fingerprint.
Disponible solo para comercios certificados en PCI.

Autorizaciones

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

Parámetros de ruta

customer_id
string
requerido

El identificador único del cliente, creado con el endpoint Create Customer (MAX 64; MIN 36).

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 de la transacción (MAX 2; MIN 2; ISO 3166-1).

Opciones disponibles:
AR,
BO,
BR,
CL,
CO,
CR,
EC,
SV,
GT,
HN,
MX,
NI,
PA,
PY,
PE,
US,
UY
type
enum<string>
requerido

El tipo de método de pago (MAX 255; MIN 3; Tipo de pago).

Opciones disponibles:
CARD,
ACH_ENROLLMENT,
NU_PAY_ENROLLMENT,
SEPA_ENROLLMENT
workflow
enum<string>
predeterminado:DIRECT

El flujo de pago indica si la integración usará el SDK de Yuno o será una conexión directa entre sistemas. Como estás en el flujo Direct, el valor debe ser DIRECT.

Opciones disponibles:
DIRECT
callback_url
string

URL a la que se devuelve al cliente después de una inscripción en el entorno de un proveedor. Solo es necesaria para integraciones de métodos de pago alternativos (MAX 255; MIN 3).

metadata
object[]

Etiquetas personalizadas opcionales de clave y valor para la inscripción (por ejemplo, on_behalf_of, order_ref). Son opacas para Yuno: se almacenan con el método de pago inscrito, se devuelven cuando lo obtienes y en el webhook enrollment.enroll, y se envían a la integración del proveedor junto con la inscripción, igual que el metadata del pago llega a él en un cobro. La entrada reservada gateway_options es la excepción: se almacena y se devuelve, pero no se reenvía con la inscripción. Hasta 120 elementos y 75000 caracteres en total, contando cada clave y cada valor.

token
string<uuid>

Token pregenerado usado para hacer referencia al método de pago que se está inscribiendo.

parent_type
string

Tipo del método de pago principal, usado al inscribir un método tokenizado o derivado (por ejemplo, CARD).

account_updater
boolean

Control por tarjeta para Card Account Updater. Cuando se define en false, esta tarjeta se excluye de Card Account Updater y no recibirá actualizaciones automáticas de los datos de la tarjeta. Cuando se omite, la tarjeta sigue la configuración de Account Updater de tu cuenta. Se aplica en la inscripción.

card_data
object

Especifica los detalles de la tarjeta. Solo para integraciones con flujo DIRECT.

customer_payer
object

Información sobre el cliente o pagador asociado con el método de pago.

payment_method
object

Envoltorio del método de pago usado para métodos que no son tarjeta (por ejemplo, transferencia bancaria / ACH) y para las opciones de vault.

provider_data
object

Datos del proveedor usados para la migración de tokens o la inscripción con token del proveedor. Envía este objeto cuando token_source sea PROVIDER_API, MIGRATION_FILE o PROVIDER_TOKEN. Su uso debe acordarse con tu asesor comercial en Yuno.

verify
object

Indica si se debe verificar el pago con una transacción de verificación o no. Necesitas tener un proveedor definido en tu ruta CARD. False por defecto.

recurring_payment
object

Metadatos de facturación recurrente o de suscripción asociados con el método inscrito.

Respuesta

201

idempotency_key
string
Ejemplo:

"2ca58c6d-8794-4c8f-a2f6-bba4b7498b74"

name
string
Ejemplo:

"VISA ****1111"

description
string
Ejemplo:

"VISA ****1111"

type
string
Ejemplo:

"CARD"

category
string
Ejemplo:

"CARD"

country
string
Ejemplo:

"US"

status
string
Ejemplo:

"ENROLLED"

sub_status
any
vaulted_token
string
Ejemplo:

"cbdcc878-ceb4-4dd8-b0f0-49d444855de0"

metadata
array
callback_url
string
Ejemplo:

"www.example.com"

action
string
redirect_url
string
Ejemplo:

null

parent_type
string
Ejemplo:

"CARD"

created_at
string
Ejemplo:

"2024-06-06T13:32:49.715656Z"

updated_at
string
Ejemplo:

"2024-06-06T13:32:49.715656Z"

card_data
object
last_successfully_used
any
last_successfully_used_at
any
preferred
any
verify
object
provider_data
object

Datos adicionales del proveedor