Deactivate a Split Beneficiary
curl --request PATCH \
--url https://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"beneficiaryId": "<string>",
"organizationId": "<string>"
}
'import requests
url = "https://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate"
payload = {
"beneficiaryId": "<string>",
"organizationId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({beneficiaryId: '<string>', organizationId: '<string>'})
};
fetch('https://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate', 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://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate",
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([
'beneficiaryId' => '<string>',
'organizationId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate"
payload := strings.NewReader("{\n \"beneficiaryId\": \"<string>\",\n \"organizationId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-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://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"beneficiaryId\": \"<string>\",\n \"organizationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"beneficiaryId\": \"<string>\",\n \"organizationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 200,
"message": "Beneficiary deactivated successfully",
"data": null
}
{
"statusCode": 400,
"message": "Validation failed",
"errors": [
"The request field is required.",
"The JSON value could not be converted to System.Guid. Path: $.organizationId | LineNumber: 1 | BytePositionInLine: 60."
],
"data": null
}
{
"code": "401",
"success": false,
"message": "x-api-key is missing in the header",
"data": null
}
{
"statusCode": 403,
"message": "Access denied. The API key provided is for another organization. You can only access your organization's wallets.",
"data": null
}
{
"code": "500",
"success": false,
"message": "An unexpected error occurred",
"data": null
}
Split Checkout
Deactivate a Split Beneficiary
Activates a split beneficiary for the authenticated organization. Organization API key required.
PATCH
/
api
/
v1
/
split-beneficiaries
/
{beneficiaryId}
/
deactivate
Deactivate a Split Beneficiary
curl --request PATCH \
--url https://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"beneficiaryId": "<string>",
"organizationId": "<string>"
}
'import requests
url = "https://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate"
payload = {
"beneficiaryId": "<string>",
"organizationId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({beneficiaryId: '<string>', organizationId: '<string>'})
};
fetch('https://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate', 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://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate",
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([
'beneficiaryId' => '<string>',
'organizationId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate"
payload := strings.NewReader("{\n \"beneficiaryId\": \"<string>\",\n \"organizationId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-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://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"beneficiaryId\": \"<string>\",\n \"organizationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://checkout-staging.embedly.ng/api/v1/split-beneficiaries/{beneficiaryId}/deactivate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"beneficiaryId\": \"<string>\",\n \"organizationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 200,
"message": "Beneficiary deactivated successfully",
"data": null
}
{
"statusCode": 400,
"message": "Validation failed",
"errors": [
"The request field is required.",
"The JSON value could not be converted to System.Guid. Path: $.organizationId | LineNumber: 1 | BytePositionInLine: 60."
],
"data": null
}
{
"code": "401",
"success": false,
"message": "x-api-key is missing in the header",
"data": null
}
{
"statusCode": 403,
"message": "Access denied. The API key provided is for another organization. You can only access your organization's wallets.",
"data": null
}
{
"code": "500",
"success": false,
"message": "An unexpected error occurred",
"data": null
}
string
required
Example:
02600494-1a3c-11f0-a818-6045bd97b81dstring
required
Example:
02600494-1a3c-11f0-a818-6045bd97b81d{
"statusCode": 200,
"message": "Beneficiary deactivated successfully",
"data": null
}
{
"statusCode": 400,
"message": "Validation failed",
"errors": [
"The request field is required.",
"The JSON value could not be converted to System.Guid. Path: $.organizationId | LineNumber: 1 | BytePositionInLine: 60."
],
"data": null
}
{
"code": "401",
"success": false,
"message": "x-api-key is missing in the header",
"data": null
}
{
"statusCode": 403,
"message": "Access denied. The API key provided is for another organization. You can only access your organization's wallets.",
"data": null
}
{
"code": "500",
"success": false,
"message": "An unexpected error occurred",
"data": null
}
⌘I