The Recipient Object

Represents a recipient in a marketplace or split-payment configuration, used to route funds to sub-merchants or sellers.

The Recipient object represents a sub-merchant, seller, or payee in a marketplace or split-payment setup. Recipients must be onboarded (KYC/KYB) before they can receive funds. Yuno manages the onboarding flow and fund distribution based on your split configuration.

Onboarding required. Recipients must complete the onboarding process before they can receive payments. Use the Transfer Onboarding endpoint to generate the onboarding link, then track progress via onboarding_status.

Object Fields

id · string

Yuno’s unique identifier for this recipient (UUID).

Example: rcp_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d

merchant_recipient_id · string

Your internal identifier for this recipient, used for reconciliation between your system and Yuno.

Example: seller-augusta-shop-001

country · string

The country where the recipient operates. ISO 3166-1 alpha-2 code. Determines onboarding requirements and payout rails.

Example: US

name · string

The recipient’s full legal name (individual) or business name (company).

Example: Augusta Shop LLC

email · string

The recipient’s contact email. Used for onboarding communications and payout notifications.

Example: [e-mail]

document · object

The recipient’s identification document. Required for KYC/KYB compliance.

Show document

document_type · string

Type of identification document.

Values: CPF, CNPJ, CC, CE, NIT, DNI, RUC, RUT, RFC, CURP, PASSPORT, NATIONAL_ID, OTHER

Example: EIN

document_number · string

Document number. Digits only, no formatting.

Example: 123456789 (EIN. 9 digits)

bank_account · object

The recipient’s bank account for receiving payouts.

Show bank_account

bank_code · string

Bank identifier code (COMPE code in Brazil, SWIFT/BIC internationally).

Example: 021000021 (Chase)

bank_name · string

Human-readable bank name.

Example: Chase

account_type · string

Type of bank account.

Values: CHECKING, SAVINGS

Example: CHECKING

account_number · string

Bank account number.

Example: 12345-6

branch_number · string

Bank branch number (agencia in Brazil).

Example: null

holder_name · string

Name of the account holder. Must match the recipient’s legal name.

Example: Augusta Shop LLC

holder_document · string

Document number of the account holder. Must match the recipient’s document.

Example: 123456789

status · string

Current operational status of the recipient.

Values: ACTIVE, INACTIVE, SUSPENDED

Example: ACTIVE

onboarding_status · string

Current status of the recipient’s KYC/KYB onboarding process.

Values: PENDING, IN_PROGRESS, COMPLETED, REJECTED, REQUIRES_ACTION

Example: COMPLETED

created_at · string

ISO 8601 timestamp of when the recipient was created.

Example: 2026-01-15T10:30:00.000Z

Example

{
  "id": "rcp_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "merchant_recipient_id": "seller-augusta-shop-001",
  "country": "US",
  "name": "Augusta Shop LLC",
  "email": "[e-mail]",
  "document": {
    "document_type": "EIN",
    "document_number": "123456789"
  },
  "bank_account": {
    "bank_code": "021000021",
    "bank_name": "Chase",
    "account_type": "CHECKING",
    "account_number": "123456789",
    "branch_number": null,
    "holder_name": "Augusta Shop LLC",
    "holder_document": "123456789"
  },
  "status": "ACTIVE",
  "onboarding_status": "COMPLETED",
  "created_at": "2026-01-15T10:30:00.000Z"
}

Onboarding Lifecycle

Status	Description
PENDING	Recipient created but onboarding not yet started.
IN_PROGRESS	Recipient has started the onboarding flow but has not completed all steps.
REQUIRES_ACTION	Additional information or documents are needed from the recipient. Use Continue Onboarding to resume.
COMPLETED	Onboarding is complete. The recipient can receive payouts.
REJECTED	Onboarding was rejected due to KYC/KYB failure. Review the reason and update the recipient’s information before retrying.

Recipients with onboarding_status other than COMPLETED cannot receive fund splits. Payments involving incomplete recipients will hold funds until onboarding is finished.

Related Endpoints

• Create Recipient. POST /v1/recipients
• Get Recipient. GET /v1/recipients/{recipient_id}
• List Recipients. GET /v1/recipients
• Update Recipient. PATCH /v1/recipients/{recipient_id}
• Delete Recipient. DELETE /v1/recipients/{recipient_id}
• Transfer Onboarding. POST /v1/recipients/{recipient_id}/onboarding
• Continue Onboarding. POST /v1/recipients/{recipient_id}/onboarding/continue

Related Concepts

• Marketplaces. How split payments and fund distribution work
• Payouts. How recipients receive their funds
• KYC/KYB. Onboarding requirements by country