Skip to main content
POST
/
v1
/
recipients
/
{recipient_id}
/
onboardings
{
  "type": "ONBOARD_ONTO_THE_PROVIDER",
  "workflow": "DIRECT",
  "provider": {
    "id": "PAGARME",
    "connection_id": "322d48b6-f423-4438-8ffb-0b9b5059a2e9"
  },
  "withdrawal_methods": [
    {
      "bank": {
        "code": "246",
        "branch": "123",
        "account": "1093333333",
        "account_type": "CHECKINGS",
        "country": "US",
        "currency": "USD"
      }
    }
  ]
}
Creates a new onboarding process for a recipient, registering them with a payment provider for marketplace split payments. The recipient must exist before starting onboarding.
A recipient can have multiple onboardings. One per provider connection. Each onboarding tracks the registration lifecycle independently.

​
Path Parameters

​
recipient_id
string
required
The unique identifier of the recipient.

​
Request Body

​
type
string
required
Type of onboarding.Values: PREVIOUSLY_ONBOARDED, ONBOARD_ONTO_THE_PROVIDER
  • PREVIOUSLY_ONBOARDED. Recipient already exists at the provider; link them in Yuno.
  • ONBOARD_ONTO_THE_PROVIDER. Register the recipient with the provider through Yuno.
​
workflow
string
required
Workflow type for the onboarding process.Values: HOSTED_BY_PROVIDER, DIRECT
  • HOSTED_BY_PROVIDER. Provider handles the onboarding UI (redirect flow).
  • DIRECT. Yuno sends the data directly to the provider API.
​
callback_url
string
URL to redirect the recipient after completing a provider-hosted onboarding flow.Example: https://www.your-site.com/onboarding-complete
​
provider
object
required
Payment provider details.
​
documentation
array
Supporting documents for the onboarding (identity, business registration, etc.).
​
withdrawal_methods
array
Bank account details for receiving payouts.
{
  "type": "ONBOARD_ONTO_THE_PROVIDER",
  "workflow": "DIRECT",
  "provider": {
    "id": "PAGARME",
    "connection_id": "322d48b6-f423-4438-8ffb-0b9b5059a2e9"
  },
  "withdrawal_methods": [
    {
      "bank": {
        "code": "246",
        "branch": "123",
        "account": "1093333333",
        "account_type": "CHECKINGS",
        "country": "US",
        "currency": "USD"
      }
    }
  ]
}