Get Onboarding
curl --request GET \
--url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id} \
--header 'private-secret-key: <api-key>' \
--header 'public-api-key: <api-key>'import requests
url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"
headers = {
"public-api-key": "<api-key>",
"private-secret-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};
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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("public-api-key", "<api-key>")
req.Header.Add("private-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")
.header("public-api-key", "<api-key>")
.header("private-secret-key", "<api-key>")
.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::Get.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "104911d-5df9-429e-8488-ad41abea1a4b",
"account_id": "9104911d-5df9-429e-8488-ad41abea1a4b",
"recipient_id": "9104911d-5df9-429e-8488-ad41abea1a4b",
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "HOSTED_BY_PROVIDER",
"status": "ACTIVE",
"callback_url": "https://www.google.com",
"provider": {
"id": "PAGARME",
"connection_id": "104911d-5df9-429e-8488-ad41abea1a4b",
"recipient_id": "AAAAA01"
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}{
"code": "INVALID_CREDENTIALS",
"messages": [
"Invalid credentials"
]
}{
"code": "AUTHORIZATION_REQUIRED",
"messages": [
"The merchant has no authorization to use this API."
]
}Get Onboarding
GET
/
recipients
/
{recipient_id}
/
onboardings
/
{onboarding_id}
Get Onboarding
curl --request GET \
--url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id} \
--header 'private-secret-key: <api-key>' \
--header 'public-api-key: <api-key>'import requests
url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"
headers = {
"public-api-key": "<api-key>",
"private-secret-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};
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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("public-api-key", "<api-key>")
req.Header.Add("private-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")
.header("public-api-key", "<api-key>")
.header("private-secret-key", "<api-key>")
.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::Get.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "104911d-5df9-429e-8488-ad41abea1a4b",
"account_id": "9104911d-5df9-429e-8488-ad41abea1a4b",
"recipient_id": "9104911d-5df9-429e-8488-ad41abea1a4b",
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "HOSTED_BY_PROVIDER",
"status": "ACTIVE",
"callback_url": "https://www.google.com",
"provider": {
"id": "PAGARME",
"connection_id": "104911d-5df9-429e-8488-ad41abea1a4b",
"recipient_id": "AAAAA01"
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}{
"code": "INVALID_CREDENTIALS",
"messages": [
"Invalid credentials"
]
}{
"code": "AUTHORIZATION_REQUIRED",
"messages": [
"The merchant has no authorization to use this API."
]
}Retrieves detailed information about a specific onboarding for a recipient.
This endpoint retrieves detailed information about a specific onboarding for a recipient in the split payments marketplace. Use this endpoint to check the current status, configuration, and details of an existing onboarding.
This endpoint requires an existing onboarding created via Create Onboarding.
Authorizations
Path Parameters
ID of the recipient
ID of the onboarding to retrieve
Response
Onboarding details retrieved successfully
The unique identifier of the onboarding
Example:
"104911d-5df9-429e-8488-ad41abea1a4b"
Unique id of the account in Yuno
Example:
"9104911d-5df9-429e-8488-ad41abea1a4b"
The unique identifier of the recipient
Example:
"9104911d-5df9-429e-8488-ad41abea1a4b"
Type of onboarding flow
Available options:
PREVIOUSLY_ONBOARDED, ONE_STEP_ONBOARDING, TWO_STEP_ONBOARDING Example:
"PREVIOUSLY_ONBOARDED"
Workflow of the onboarding
Available options:
HOSTED_BY_PROVIDER, HOSTED_BY_YUNO, DIRECT Example:
"HOSTED_BY_PROVIDER"
Current status of the onboarding
Example:
"ACTIVE"
URL to redirect after the onboarding process
Example:
"https://www.google.com"
Show child attributes
Show child attributes
Onboarding creation date
Example:
"2024-01-15T10:30:00Z"
Onboarding last update date
Example:
"2024-01-15T10:30:00Z"
Was this page helpful?