NuPay
Esta guía explora la integración NuPay de Yuno utilizando el flujo de trabajo Directo. Aprenderás cómo:
- Inscribir NuPay como método de pago del cliente
- Hacer pagos a plazospago condiciones depago )
- Configurar suscripciones
Requisitos
Antes de empezar, necesitas
- Una cuenta Yuno con acceso al Panel de control
- Claves API y un
account_id(encontrado en el salpicadero) - Un cliente creado en Yuno (o crea uno en el Paso 1)
Crear y gestionar clientes
Crea el cliente una vez utilizando tu externo merchant_customer_idy luego recuperar por Yuno id o por merchant_customer_id según sea necesario.
- Use el endpoint Crear Cliente y proporciona tu propio
merchant_customer_id(el identificador único del cliente en tu sistema). La respuesta devuelveidque es el identificador de cliente de Yuno. - Usar Recuperar Cliente con el Yuno
id. - Usar Recuperar cliente por Id externo con el parámetro de consulta
merchant_customer_id.
Inscribirse en el método de pago NuPay
Sigue estos pasos para inscribirte NU_PAY_ENROLLMENT a un cliente utilizando el flujo de trabajo Directo.
Paso 1: Crea un cliente
Si aún no tienes un cliente, crea uno como se muestra arriba. Utilizarás el cliente devuelto id.
Paso 2: Inscríbete en el método de pago
Utiliza el Método Enroll pago con los siguientes parámetros de pedido :
- tipo:
NU_PAY_ENROLLMENT - account_id: UUID de tu cuenta (desde el Panel de Control de Yuno)
- workflow:
DIRECT
Campos de respuesta esperados:
- clave_de_pago: UUID para el método de pago registrado
- status:
READY_TO_ENROLL - sub_estado:
WAITING_ADDITIONAL_STEP - acción:
REDIRECT_URL - redirect_url: URL para redirigir al cliente a Nu para la autenticación
Paso 3: Redirige al cliente
Redirige al cliente a la página redirect_url. El cliente completa el flujo Nu. Nu notifica a Yuno el estado final.
Paso 4: Confirmar la inscripción
Usar Recuperar método de pago inscrito por id con el endpoint vaulted_token. Vuelve a inscribirte con éxito:
- status:
ENROLLED - sub_estado:
ENROLLED
La inscripción sólo se completa cuando Yuno recibe la confirmación de Nu.
Pagos con condiciones de pago (plazos)
Después de inscribirte, puedes aceptar pagos con NuPay utilizando las condiciones de pago .
Paso 1: Garantizar los requisitos previos
Tener un cliente Yuno id y un NuPay inscrito vaulted_token.
Paso 2: Consigue las condiciones de pago
pedido las opciones de pago a plazos disponibles para NuPay utilizando el endpoint de pagos a plazos de APM.
curl --location 'https://api-sandbox.y.uno/v1/apm-installments' \
--header 'public-api-key: {{your_public_api_key}}' \
--header 'private-secret-key: {{your_secret_api_key}}' \
--header 'X-account-code: {{your_account_code}}' \
--header 'Content-Type: application/json' \
--data '{
"country": "BR",
"amount": {
"currency": "BRL",
"value": "250"
},
"customer": {
"id": "{{customer_id}}"
},
"payment_method": "NU_PAY_ENROLLMENT",
"vaulted_token": "{{vaulted_token}}"
}'La respuesta devuelve una matriz de planes de pago a plazos, que incluye id, disponible installmentse importes. Selecciona un plan id y un número de plazos permitidos.
Paso 3: Crear pago
Usar Crear pago con el flujo de trabajo Directo y el tipo NuPay. Incluye el identificador del plan seleccionado y los plazos en el monedero card_data.
{
"description": "test",
"account_id": "{{account_id}}",
"merchant_order_id": "0000023",
"country": "BR",
"merchant_reference": "ref-merchant-AA01",
"amount": {
"currency": "BRL",
"value": 250
},
"customer_payer": {
"id": "{{customer_id}}"
},
"workflow": "DIRECT",
"callback_url": "https://your-callback.com",
"payment_method": {
"type": "NU_PAY_ENROLLMENT",
"vaulted_token": "{{vaulted_token}}",
"detail": {
"wallet": {
"card_data": {
"installments_plan_id": "{{plan_id}}",
"installments": 2
}
}
}
}
}Paso 4: Recuperar pago
Utiliza Recuperar pago por id para confirmar el estado final.
Flujo de suscripción
Puedes utilizar NuPay para cargos recurrentes.
- Crear un Cliente
- Inscribe NuPay como método de pago (ver más arriba)
- Crear una suscripción con los inscritos
vaulted_tokenutilizando Crear suscripción - Recupera la suscripción utilizando Recuperar suscripción
Limitaciones
- Las suscripciones con NuPay no admiten condiciones de pago (cuotas)
- No se admite la creación de suscripciones directamente dentro de un pago pedido
Endpoints
Actualizado hace 3 meses