Update recipient
curl --request PUT \
--url https://api-sandbox.endl.io/api/v0/pobo/recipients \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "rec_xxxxxxxxxxxxxxxxxxxx",
"type": "INDIVIDUAL",
"alias": "Juan (updated)",
"email": "juan.new@example.com"
}
'import requests
url = "https://api-sandbox.endl.io/api/v0/pobo/recipients"
payload = {
"id": "rec_xxxxxxxxxxxxxxxxxxxx",
"type": "INDIVIDUAL",
"alias": "Juan (updated)",
"email": "juan.new@example.com"
}
headers = {
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'rec_xxxxxxxxxxxxxxxxxxxx',
type: 'INDIVIDUAL',
alias: 'Juan (updated)',
email: 'juan.new@example.com'
})
};
fetch('https://api-sandbox.endl.io/api/v0/pobo/recipients', 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.endl.io/api/v0/pobo/recipients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'rec_xxxxxxxxxxxxxxxxxxxx',
'type' => 'INDIVIDUAL',
'alias' => 'Juan (updated)',
'email' => 'juan.new@example.com'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json"
],
]);
$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.endl.io/api/v0/pobo/recipients"
payload := strings.NewReader("{\n \"id\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"type\": \"INDIVIDUAL\",\n \"alias\": \"Juan (updated)\",\n \"email\": \"juan.new@example.com\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("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.put("https://api-sandbox.endl.io/api/v0/pobo/recipients")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"type\": \"INDIVIDUAL\",\n \"alias\": \"Juan (updated)\",\n \"email\": \"juan.new@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.endl.io/api/v0/pobo/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"type\": \"INDIVIDUAL\",\n \"alias\": \"Juan (updated)\",\n \"email\": \"juan.new@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"message": "Success",
"status": "SUCCESS",
"data": {},
"errors": []
}{
"code": 400,
"message": "Rail not supported for POBO",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "VALIDATION_ERROR",
"message": "Rail not supported for POBO",
"field": null
}
]
}{
"data": null,
"code": 401,
"message": "Authentication Failed!",
"status": "Error",
"errors": [
{
"code": "401",
"message": "Authentication Failed!",
"field": "Authentication Failed!"
}
]
}{
"data": null,
"code": 403,
"message": "API key does not have 'pobo' permission",
"status": "Error",
"errors": [
{
"code": "403",
"message": "API key does not have 'pobo' permission",
"field": "API key does not have 'pobo' permission"
}
]
}{
"code": 404,
"message": "Resource not found",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "NOT_FOUND",
"message": "Resource not found",
"field": null
}
]
}{
"data": null,
"code": 429,
"message": "Rate limit exceeded, please retry later",
"status": "Error",
"errors": [
{
"code": "429",
"message": "Rate limit exceeded, please retry later",
"field": "Rate limit exceeded, please retry later"
}
]
}{
"code": 500,
"message": "Unexpected error",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "INTERNAL_ERROR",
"message": "Unexpected error",
"field": null
}
]
}{
"data": null,
"code": 502,
"message": "Upstream service error",
"status": "Error",
"errors": null
}Update a recipient. id is the recipient reference id (rec_…), sent in the body rather than the path.
PUT
/
api
/
v0
/
pobo
/
recipients
Update recipient
curl --request PUT \
--url https://api-sandbox.endl.io/api/v0/pobo/recipients \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "rec_xxxxxxxxxxxxxxxxxxxx",
"type": "INDIVIDUAL",
"alias": "Juan (updated)",
"email": "juan.new@example.com"
}
'import requests
url = "https://api-sandbox.endl.io/api/v0/pobo/recipients"
payload = {
"id": "rec_xxxxxxxxxxxxxxxxxxxx",
"type": "INDIVIDUAL",
"alias": "Juan (updated)",
"email": "juan.new@example.com"
}
headers = {
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'rec_xxxxxxxxxxxxxxxxxxxx',
type: 'INDIVIDUAL',
alias: 'Juan (updated)',
email: 'juan.new@example.com'
})
};
fetch('https://api-sandbox.endl.io/api/v0/pobo/recipients', 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.endl.io/api/v0/pobo/recipients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'rec_xxxxxxxxxxxxxxxxxxxx',
'type' => 'INDIVIDUAL',
'alias' => 'Juan (updated)',
'email' => 'juan.new@example.com'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json"
],
]);
$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.endl.io/api/v0/pobo/recipients"
payload := strings.NewReader("{\n \"id\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"type\": \"INDIVIDUAL\",\n \"alias\": \"Juan (updated)\",\n \"email\": \"juan.new@example.com\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("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.put("https://api-sandbox.endl.io/api/v0/pobo/recipients")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"type\": \"INDIVIDUAL\",\n \"alias\": \"Juan (updated)\",\n \"email\": \"juan.new@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.endl.io/api/v0/pobo/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"type\": \"INDIVIDUAL\",\n \"alias\": \"Juan (updated)\",\n \"email\": \"juan.new@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"message": "Success",
"status": "SUCCESS",
"data": {},
"errors": []
}{
"code": 400,
"message": "Rail not supported for POBO",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "VALIDATION_ERROR",
"message": "Rail not supported for POBO",
"field": null
}
]
}{
"data": null,
"code": 401,
"message": "Authentication Failed!",
"status": "Error",
"errors": [
{
"code": "401",
"message": "Authentication Failed!",
"field": "Authentication Failed!"
}
]
}{
"data": null,
"code": 403,
"message": "API key does not have 'pobo' permission",
"status": "Error",
"errors": [
{
"code": "403",
"message": "API key does not have 'pobo' permission",
"field": "API key does not have 'pobo' permission"
}
]
}{
"code": 404,
"message": "Resource not found",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "NOT_FOUND",
"message": "Resource not found",
"field": null
}
]
}{
"data": null,
"code": 429,
"message": "Rate limit exceeded, please retry later",
"status": "Error",
"errors": [
{
"code": "429",
"message": "Rate limit exceeded, please retry later",
"field": "Rate limit exceeded, please retry later"
}
]
}{
"code": 500,
"message": "Unexpected error",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "INTERNAL_ERROR",
"message": "Unexpected error",
"field": null
}
]
}{
"data": null,
"code": 502,
"message": "Upstream service error",
"status": "Error",
"errors": null
}Authorizations
Your partner API key. Must carry the pobo permission.
Body
application/json
The recipient reference id — rec_….
INDIVIDUAL or BUSINESS.
Available options:
INDIVIDUAL, BUSINESS Given name.
Family name.
Your own label for this recipient.
Contact email.
Contact phone in E.164.
Receiving bank.
Account number at the receiving bank.
SWIFT/BIC of the receiving bank.
Account type — SAVINGS, CHECKING.
Destination currency, ISO 4217 — PHP.
Payout rail. POBO accepts Paywho rails only.
Relationship of the recipient to your customer.
Postal address. countryThreeLetter is the ISO 3166-1 alpha-3 code.
Show child attributes
Show child attributes
Response
The updated recipient.