Recipients & Transfers
Cancel Onboarding
Cancel an in-progress onboarding process for a recipient.
POST
/
v1
/
recipients
/
{recipient_id}
/
onboardings
/
{onboarding_id}
/
cancel
Cancel Onboarding
curl --request POST \
--url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancelimport requests
url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel', 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}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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}/cancel"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyCancels an in-progress onboarding process for a recipient. Once cancelled, the onboarding status transitions to
CANCELLED. To restart, create a new onboarding.
This action is not reversible for the same onboarding record. To resume onboarding after cancellation, you must Create a new Onboarding.
Path Parameters
string
required
The unique identifier of the recipient.
string
required
The unique identifier of the onboarding process to cancel.
Related Pages
- Onboarding Statuses. Status lifecycle reference
- Create Onboarding. Start a new onboarding after cancellation
- Block Onboarding. Temporarily suspend instead of cancelling
⌘I
Cancel Onboarding
curl --request POST \
--url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancelimport requests
url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel', 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}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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}/cancel"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body