Update Onboarding

Update onboarding

curl --request PATCH \
  --url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id} \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "account_id": "{{account_id}}",
  "provider": {
    "id": "YUNO_TEST_PAYMENT_GW",
    "connection_id": "{{connection_id}}",
    "recipient_type": "MULTI_BENEFITS"
  }
}
'

import requests

url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"

payload = {
    "account_id": "{{account_id}}",
    "provider": {
        "id": "YUNO_TEST_PAYMENT_GW",
        "connection_id": "{{connection_id}}",
        "recipient_type": "MULTI_BENEFITS"
    }
}
headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_id: '{{account_id}}',
    provider: {
      id: 'YUNO_TEST_PAYMENT_GW',
      connection_id: '{{connection_id}}',
      recipient_type: 'MULTI_BENEFITS'
    }
  })
};

fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '{{account_id}}',
    'provider' => [
        'id' => 'YUNO_TEST_PAYMENT_GW',
        'connection_id' => '{{connection_id}}',
        'recipient_type' => 'MULTI_BENEFITS'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"

	payload := strings.NewReader("{\n  \"account_id\": \"{{account_id}}\",\n  \"provider\": {\n    \"id\": \"YUNO_TEST_PAYMENT_GW\",\n    \"connection_id\": \"{{connection_id}}\",\n    \"recipient_type\": \"MULTI_BENEFITS\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"{{account_id}}\",\n  \"provider\": {\n    \"id\": \"YUNO_TEST_PAYMENT_GW\",\n    \"connection_id\": \"{{connection_id}}\",\n    \"recipient_type\": \"MULTI_BENEFITS\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"{{account_id}}\",\n  \"provider\": {\n    \"id\": \"YUNO_TEST_PAYMENT_GW\",\n    \"connection_id\": \"{{connection_id}}\",\n    \"recipient_type\": \"MULTI_BENEFITS\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3aaa4d82-11e8-48ce-8ef5-04eee3a10802",
  "account_id": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482",
  "merchant_recipient_id": "MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6",
  "national_entity": "INDIVIDUAL",
  "entity_type": "PRIVATE",
  "first_name": "Juan",
  "last_name": "Perez",
  "legal_name": null,
  "email": "juan.perez@example.com",
  "date_of_birth": "1990-01-15",
  "country": "CO",
  "website": "https://juanperez.com",
  "industry": "Technology",
  "merchant_category_code": "5734",
  "document": {
    "document_number": "1234567890",
    "document_type": "CC"
  },
  "phone": {
    "country_code": "57",
    "number": "3001234567"
  },
  "address": {
    "address_line_1": "Carrera 7 # 32-16",
    "address_line_2": "Oficina 201",
    "city": "Bogota",
    "country": "CO",
    "state": "Cundinamarca",
    "zip_code": "110311",
    "neighborhood": "Centro"
  },
  "legal_representatives": [
    {
      "merchant_reference": "REP_001",
      "first_name": "Maria",
      "last_name": "Gonzalez",
      "email": "maria.gonzalez@example.com",
      "date_of_birth": "1985-05-20",
      "country": "CO",
      "nationality": "CO",
      "title": "CEO",
      "publicly_exposed_person": false,
      "ultimate_beneficial_owner": true,
      "document": {
        "document_type": "CC",
        "document_number": "0987654321"
      },
      "phone": {
        "country_code": "57",
        "number": "3109876543"
      },
      "address": {
        "address_line_1": "Calle 26 # 13-19",
        "address_line_2": null,
        "country": "CO",
        "state": "Cundinamarca",
        "city": "Bogota",
        "zip_code": "110311"
      }
    }
  ],
  "withdrawal_methods": {
    "bank": {
      "code": "001",
      "branch": "004",
      "branch_digit": "123",
      "account": "1234567890",
      "account_digit": "123",
      "account_type": "SAVINGS",
      "routing": "021000021",
      "country": "CO",
      "currency": "COP"
    }
  },
  "documentation": [
    {
      "file_name": "cc-front.pdf",
      "content_type": "application/pdf",
      "content_category": "IDENTIFICATION",
      "content": "JVBERi0xLjQKJ..."
    }
  ],
  "onboardings": [
    {
      "id": "84c42684-dbe5-4e0f-bd17-4d094e19762d",
      "type": "ONBOARD_ONTO_THE_PROVIDER",
      "workflow": "DIRECT",
      "status": "PENDING",
      "callback_url": "https://merchant.example.com/webhook/onboarding",
      "provider": {
        "id": "ALELO",
        "connection_id": "cc389b51-53a1-4a29-af40-c8cee26c3399",
        "recipient_id": null,
        "redirect_url": null,
        "onboarding_url": null,
        "legal_entity": null,
        "balance_account_id": null,
        "legal_entity_id": null
      },
      "documentation": [
        {
          "file_name": "utility-bill.pdf",
          "content_type": "application/pdf",
          "content_category": "ADDRESS_PROOF",
          "content": "JVBERi0xLjQKJ..."
        }
      ],
      "legal_representatives": [],
      "requirements": [
        {
          "field": "document.cc",
          "message": "Provide CC document image",
          "status": "PENDING"
        }
      ],
      "withdrawal_methods": {
        "bank": {
          "code": "002",
          "branch": "002",
          "branch_digit": null,
          "account": "9876543210",
          "account_digit": null,
          "account_type": "SAVINGS",
          "routing": "021000022",
          "country": "CO",
          "currency": "COP"
        }
      },
      "terms_of_service": {
        "acceptance": true,
        "date": "2025-07-21T20:43:54Z",
        "ip": "129.21.111.11"
      },
      "created_at": "2025-08-27T15:41:19.516982Z",
      "updated_at": "2025-08-27T15:41:19.516989Z"
    }
  ],
  "split_configuration": {
    "calculation_type": "PERCENTAGE",
    "percentage": 10.5,
    "fixed_amount": 5,
    "currency": "USD",
    "rounding_mode": "STANDARD"
  },
  "created_at": "2025-08-27T15:41:19.497413Z",
  "updated_at": "2025-08-27T15:41:19.497425Z"
}

{
  "code": "INVALID_REQUEST",
  "messages": [
    "Invalid request format"
  ]
}

{
  "code": "INVALID_CREDENTIALS",
  "messages": [
    "Invalid credentials"
  ]
}

{
  "code": "AUTHORIZATION_REQUIRED",
  "messages": [
    "The merchant has no authorization to use this API."
  ]
}

PATCH

recipients

{recipient_id}

onboardings

{onboarding_id}

Update onboarding

curl --request PATCH \
  --url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id} \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "account_id": "{{account_id}}",
  "provider": {
    "id": "YUNO_TEST_PAYMENT_GW",
    "connection_id": "{{connection_id}}",
    "recipient_type": "MULTI_BENEFITS"
  }
}
'

import requests

url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"

payload = {
    "account_id": "{{account_id}}",
    "provider": {
        "id": "YUNO_TEST_PAYMENT_GW",
        "connection_id": "{{connection_id}}",
        "recipient_type": "MULTI_BENEFITS"
    }
}
headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_id: '{{account_id}}',
    provider: {
      id: 'YUNO_TEST_PAYMENT_GW',
      connection_id: '{{connection_id}}',
      recipient_type: 'MULTI_BENEFITS'
    }
  })
};

fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '{{account_id}}',
    'provider' => [
        'id' => 'YUNO_TEST_PAYMENT_GW',
        'connection_id' => '{{connection_id}}',
        'recipient_type' => 'MULTI_BENEFITS'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"

	payload := strings.NewReader("{\n  \"account_id\": \"{{account_id}}\",\n  \"provider\": {\n    \"id\": \"YUNO_TEST_PAYMENT_GW\",\n    \"connection_id\": \"{{connection_id}}\",\n    \"recipient_type\": \"MULTI_BENEFITS\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"{{account_id}}\",\n  \"provider\": {\n    \"id\": \"YUNO_TEST_PAYMENT_GW\",\n    \"connection_id\": \"{{connection_id}}\",\n    \"recipient_type\": \"MULTI_BENEFITS\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"{{account_id}}\",\n  \"provider\": {\n    \"id\": \"YUNO_TEST_PAYMENT_GW\",\n    \"connection_id\": \"{{connection_id}}\",\n    \"recipient_type\": \"MULTI_BENEFITS\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3aaa4d82-11e8-48ce-8ef5-04eee3a10802",
  "account_id": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482",
  "merchant_recipient_id": "MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6",
  "national_entity": "INDIVIDUAL",
  "entity_type": "PRIVATE",
  "first_name": "Juan",
  "last_name": "Perez",
  "legal_name": null,
  "email": "juan.perez@example.com",
  "date_of_birth": "1990-01-15",
  "country": "CO",
  "website": "https://juanperez.com",
  "industry": "Technology",
  "merchant_category_code": "5734",
  "document": {
    "document_number": "1234567890",
    "document_type": "CC"
  },
  "phone": {
    "country_code": "57",
    "number": "3001234567"
  },
  "address": {
    "address_line_1": "Carrera 7 # 32-16",
    "address_line_2": "Oficina 201",
    "city": "Bogota",
    "country": "CO",
    "state": "Cundinamarca",
    "zip_code": "110311",
    "neighborhood": "Centro"
  },
  "legal_representatives": [
    {
      "merchant_reference": "REP_001",
      "first_name": "Maria",
      "last_name": "Gonzalez",
      "email": "maria.gonzalez@example.com",
      "date_of_birth": "1985-05-20",
      "country": "CO",
      "nationality": "CO",
      "title": "CEO",
      "publicly_exposed_person": false,
      "ultimate_beneficial_owner": true,
      "document": {
        "document_type": "CC",
        "document_number": "0987654321"
      },
      "phone": {
        "country_code": "57",
        "number": "3109876543"
      },
      "address": {
        "address_line_1": "Calle 26 # 13-19",
        "address_line_2": null,
        "country": "CO",
        "state": "Cundinamarca",
        "city": "Bogota",
        "zip_code": "110311"
      }
    }
  ],
  "withdrawal_methods": {
    "bank": {
      "code": "001",
      "branch": "004",
      "branch_digit": "123",
      "account": "1234567890",
      "account_digit": "123",
      "account_type": "SAVINGS",
      "routing": "021000021",
      "country": "CO",
      "currency": "COP"
    }
  },
  "documentation": [
    {
      "file_name": "cc-front.pdf",
      "content_type": "application/pdf",
      "content_category": "IDENTIFICATION",
      "content": "JVBERi0xLjQKJ..."
    }
  ],
  "onboardings": [
    {
      "id": "84c42684-dbe5-4e0f-bd17-4d094e19762d",
      "type": "ONBOARD_ONTO_THE_PROVIDER",
      "workflow": "DIRECT",
      "status": "PENDING",
      "callback_url": "https://merchant.example.com/webhook/onboarding",
      "provider": {
        "id": "ALELO",
        "connection_id": "cc389b51-53a1-4a29-af40-c8cee26c3399",
        "recipient_id": null,
        "redirect_url": null,
        "onboarding_url": null,
        "legal_entity": null,
        "balance_account_id": null,
        "legal_entity_id": null
      },
      "documentation": [
        {
          "file_name": "utility-bill.pdf",
          "content_type": "application/pdf",
          "content_category": "ADDRESS_PROOF",
          "content": "JVBERi0xLjQKJ..."
        }
      ],
      "legal_representatives": [],
      "requirements": [
        {
          "field": "document.cc",
          "message": "Provide CC document image",
          "status": "PENDING"
        }
      ],
      "withdrawal_methods": {
        "bank": {
          "code": "002",
          "branch": "002",
          "branch_digit": null,
          "account": "9876543210",
          "account_digit": null,
          "account_type": "SAVINGS",
          "routing": "021000022",
          "country": "CO",
          "currency": "COP"
        }
      },
      "terms_of_service": {
        "acceptance": true,
        "date": "2025-07-21T20:43:54Z",
        "ip": "129.21.111.11"
      },
      "created_at": "2025-08-27T15:41:19.516982Z",
      "updated_at": "2025-08-27T15:41:19.516989Z"
    }
  ],
  "split_configuration": {
    "calculation_type": "PERCENTAGE",
    "percentage": 10.5,
    "fixed_amount": 5,
    "currency": "USD",
    "rounding_mode": "STANDARD"
  },
  "created_at": "2025-08-27T15:41:19.497413Z",
  "updated_at": "2025-08-27T15:41:19.497425Z"
}

{
  "code": "INVALID_REQUEST",
  "messages": [
    "Invalid request format"
  ]
}

{
  "code": "INVALID_CREDENTIALS",
  "messages": [
    "Invalid credentials"
  ]
}

{
  "code": "AUTHORIZATION_REQUIRED",
  "messages": [
    "The merchant has no authorization to use this API."
  ]
}

Updates an existing onboarding for a recipient. Only specified fields will be updated. This endpoint updates an existing onboarding for a recipient, allowing you to modify onboarding details after initial creation. Use this when you need to update provider information, documentation, banking details, or other onboarding parameters for existing recipients in the split payments marketplace.

Prerequisites

This endpoint requires an existing onboarding created via Create Onboarding

Authorizations

public-api-key

string

header

default:<Your public-api-key>

required

private-secret-key

string

header

default:<Your private-secret-key>

required

Path Parameters

recipient_id

string

required

ID of the recipient whose onboarding will be updated

onboarding_id

string

required

ID of the onboarding to be updated

Body

application/json

account_id

string

Unique id of the account in Yuno

Example:

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

type

enum<string>

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

Available options:

PREVIOUSLY_ONBOARDED,

ONE_STEP_ONBOARDING,

TWO_STEP_ONBOARDING

Example:

"PREVIOUSLY_ONBOARDED"

workflow

enum<string>

Workflow of the onboarding

Available options:

HOSTED_BY_PROVIDER,

HOSTED_BY_YUNO,

DIRECT

Example:

"HOSTED_BY_PROVIDER"

callback_url

string<uri>

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

Example:

"https://www.google.com"

provider

object

Show child attributes

documentation

object[]

Specifies the documentation object.

Show child attributes

withdrawal_methods

object

Specifies the withdrawal methods object.

Show child attributes

legal_representatives

object[]

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

Show child attributes

terms_of_service

object

Object describing terms of service.

Show child attributes

Response

Updated

string

The unique identifier of the recipient.

Example:

"3aaa4d82-11e8-48ce-8ef5-04eee3a10802"

account_id

string

The account identifier associated with this recipient.

Example:

"fe14c7c6-c75e-43b7-bdbe-4c87ad52c482"

merchant_recipient_id

string

Unique identifier of the recipient defined by the merchant.

Example:

"MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6"

national_entity

string

Beneficiary's national entity type.

Example:

"INDIVIDUAL"

entity_type

string

Beneficiary's type of organization.

Example:

"PRIVATE"

first_name

string

Beneficiary's name.

Example:

"Juan"

last_name

string

Beneficiary's last name.

Example:

"Perez"

legal_name

string | null

Beneficiary's legal name.

Example:

null

string

The Beneficiary's email.

Example:

"juan.perez@example.com"

date_of_birth

string

Beneficiary's date of birth.

Example:

"1990-01-15"

country

string

The Beneficiary's country.

Example:

"CO"

website

string

The seller's website URL.

Example:

"https://juanperez.com"

industry

string

The seller's industry.

Example:

"Technology"

merchant_category_code

string

The merchant category code (MCC) (MAX 235; MIN 1).

Example:

"5734"

document

object

Show child attributes

phone

object

Show child attributes

address

object

Show child attributes

legal_representatives

object[]

Show child attributes

withdrawal_methods

object

Show child attributes

documentation

object[]

Show child attributes

onboardings

object[]

Show child attributes

split_configuration

object

Rules for automatic split calculation at the recipient level.

Show child attributes

created_at

string<date-time>

Recipient creation date (ISO 8601 MAX 27; MIN 27).

Example:

"2025-08-27T15:41:19.497413Z"

updated_at

string<date-time>

Last Recipient updated date (ISO 8601 MAX 27; MIN 27).

Example:

"2025-08-27T15:41:19.497425Z"

Get Transfers

Standalone Transfers

Prerequisites

Authorizations

Path Parameters

Body

Response

​Prerequisites

Authorizations

Path Parameters

Body

Response

Prerequisites