Saltar al contenido principal
GET
Obtener onboarding
Obtiene información detallada sobre un onboarding específico de un destinatario. Este endpoint obtiene información detallada sobre un onboarding específico de un destinatario en el marketplace de pagos con split. Usa este endpoint para consultar el estado actual, la configuración y los detalles de un onboarding existente. Este endpoint requiere un onboarding existente creado mediante Create Onboarding.

Autorizaciones

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

Parámetros de ruta

recipient_id
string
requerido

ID del destinatario

onboarding_id
string
requerido

ID del onboarding que se va a obtener

Respuesta

Detalles del onboarding obtenidos correctamente

id
string

Identificador único del onboarding

Ejemplo:

"9104911d-5df9-429e-8488-ad41abea1a4b"

account_id
string

ID único de la cuenta en Yuno

Ejemplo:

"9104911d-5df9-429e-8488-ad41abea1a4b"

recipient_id
string

El identificador único del destinatario

Ejemplo:

"9104911d-5df9-429e-8488-ad41abea1a4b"

type
enum<string>

Tipo de flujo de onboarding

Opciones disponibles:
PREVIOUSLY_ONBOARDED,
ONE_STEP_ONBOARDING,
TWO_STEP_ONBOARDING
Ejemplo:

"PREVIOUSLY_ONBOARDED"

workflow
enum<string>

Flujo del onboarding

Opciones disponibles:
HOSTED_BY_PROVIDER,
HOSTED_BY_YUNO,
DIRECT
Ejemplo:

"HOSTED_BY_PROVIDER"

status
string

Estado actual del onboarding

Ejemplo:

"ACTIVE"

callback_url
string<uri>

URL a la que redirigir después del proceso de onboarding

Ejemplo:

"https://www.google.com"

provider
object
created_at
string<date-time>

Fecha de creación del onboarding

Ejemplo:

"2024-01-15T10:30:00Z"

updated_at
string<date-time>

Fecha de la última actualización del onboarding

Ejemplo:

"2024-01-15T10:30:00Z"