API Reference
  1. Yuno API Reference
  2. Recipients for Marketplace

Create Onboarding

post
https://api-sandbox.y.uno/v1/recipients//onboardings

Creates an onboarding for a recipient.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint creates an onboarding for a recipient, enabling submerchants to be integrated with payment providers for split payment scenarios. Use this to register new submerchants or set up recipients before they can receive split payments.

Overview

Onboarding is the first step in the split payments marketplace workflow. Each recipient (submerchant) must be onboarded with payment providers before they can receive split payments.

The onboarding process supports two flows:

  • Pre-onboarded accounts: For submerchants already registered with providers. Use type: "PREVIOUSLY_ONBOARDED".
  • Dynamic onboarding: For new submerchant registration including KYC/KYB (Know Your Customer/Know Your Business) validation. Use type: "ONE_STEP_ONBOARDING" or type: "TWO_STEP_ONBOARDING" (previously type: "ONBOARD_ONTO_PROVIDER").
📘

Two-Step Onboarding

For type: "TWO_STEP_ONBOARDING" flows, use the Continue Onboarding endpoint to complete the KYC process after account creation.

Path Params
string
required

ID of the new recipient to whom the onboarding will be transferred

Body Params
string
required

Unique id of the account in Yuno

string
enum
required

Type of onboarding flow. PREVIOUSLY_ONBOARDED for pre-existing accounts, ONE_STEP_ONBOARDING for account creation + KYC in one step, TWO_STEP_ONBOARDING for account creation first then KYC later

Allowed:
string
enum
required

Workflow of the onboarding

Allowed:
string
length between 3 and 255

Optional description of the onboarding (MAX 255; MIN 3).

uri

URL in case to redirect your customer after the onboarding process with the provider, if needed.

provider
object
required
documentation
array of objects

Specifies the documentation object.

documentation
withdrawal_methods
object

Specifies the withdrawal methods object.

legal_representatives
array of objects

Object to indicate the owners of the organization. Adyen, Stripe and dlocal have fields related to that.

legal_representatives
terms_of_service
object

Object describing terms of service.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?