Saltar al contenido principal
POST
Cancelar onboarding
Cancela un onboarding de un destinatario. Un onboarding en estado SUCCEEDED, BLOCKED, CANCELLED, INACTIVE, TRANSFERRED o TERMINATED no se puede cancelar, y la API devuelve 400 INVALID_STATE. Un onboarding cancelado es definitivo. Para volver a hacer el onboarding del destinatario con el proveedor, crea un nuevo 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

El identificador único del destinatario

onboarding_id
string
requerido

El identificador único del onboarding asociado a esta acción.

Respuesta

Onboarding cancelado correctamente

id
string

El identificador único del onboarding.

type
enum<string>

Tipo de flujo de onboarding.

Opciones disponibles:
PREVIOUSLY_ONBOARDED,
ONE_STEP_ONBOARDING,
TWO_STEP_ONBOARDING
workflow
enum<string>

Flujo de trabajo del onboarding.

Opciones disponibles:
HOSTED_BY_PROVIDER,
DIRECT
status
string

Estado actual del onboarding. CANCELLED después de una cancelación.

callback_url
string

URL a la que se redirige después del proceso de onboarding.

provider
object
documentation
object[]
requirements
any[]
withdrawal_methods
object
terms_of_service
object
recipient
object

El destinatario al que pertenece el onboarding.

history
object

Instantánea del onboarding.

created_at
string<date-time>
updated_at
string<date-time>