Create sender
curl --request POST \
--url https://api-sandbox.endl.io/api/v0/pobo/senders \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "INDIVIDUAL",
"firstName": "Maria",
"lastName": "Santos",
"email": "maria.santos@example.com",
"phone": "+639171234567",
"dateOfBirth": "1988-04-12",
"governmentId": "P1234567",
"governmentIdType": "PASSPORT",
"governmentIdIssueCountry": "PHL",
"nationality": "PHL",
"occupation": "Software Engineer",
"relationshipToCustomer": "SELF",
"address": {
"addressLine1": "12 Rizal Ave",
"city": "Manila",
"state": "Metro Manila",
"country": "Philippines",
"postalCode": "1000",
"countryThreeLetter": "PHL"
}
}
'import requests
url = "https://api-sandbox.endl.io/api/v0/pobo/senders"
payload = {
"type": "INDIVIDUAL",
"firstName": "Maria",
"lastName": "Santos",
"email": "maria.santos@example.com",
"phone": "+639171234567",
"dateOfBirth": "1988-04-12",
"governmentId": "P1234567",
"governmentIdType": "PASSPORT",
"governmentIdIssueCountry": "PHL",
"nationality": "PHL",
"occupation": "Software Engineer",
"relationshipToCustomer": "SELF",
"address": {
"addressLine1": "12 Rizal Ave",
"city": "Manila",
"state": "Metro Manila",
"country": "Philippines",
"postalCode": "1000",
"countryThreeLetter": "PHL"
}
}
headers = {
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'INDIVIDUAL',
firstName: 'Maria',
lastName: 'Santos',
email: 'maria.santos@example.com',
phone: '+639171234567',
dateOfBirth: '1988-04-12',
governmentId: 'P1234567',
governmentIdType: 'PASSPORT',
governmentIdIssueCountry: 'PHL',
nationality: 'PHL',
occupation: 'Software Engineer',
relationshipToCustomer: 'SELF',
address: {
addressLine1: '12 Rizal Ave',
city: 'Manila',
state: 'Metro Manila',
country: 'Philippines',
postalCode: '1000',
countryThreeLetter: 'PHL'
}
})
};
fetch('https://api-sandbox.endl.io/api/v0/pobo/senders', 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/senders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'INDIVIDUAL',
'firstName' => 'Maria',
'lastName' => 'Santos',
'email' => 'maria.santos@example.com',
'phone' => '+639171234567',
'dateOfBirth' => '1988-04-12',
'governmentId' => 'P1234567',
'governmentIdType' => 'PASSPORT',
'governmentIdIssueCountry' => 'PHL',
'nationality' => 'PHL',
'occupation' => 'Software Engineer',
'relationshipToCustomer' => 'SELF',
'address' => [
'addressLine1' => '12 Rizal Ave',
'city' => 'Manila',
'state' => 'Metro Manila',
'country' => 'Philippines',
'postalCode' => '1000',
'countryThreeLetter' => 'PHL'
]
]),
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/senders"
payload := strings.NewReader("{\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"Maria\",\n \"lastName\": \"Santos\",\n \"email\": \"maria.santos@example.com\",\n \"phone\": \"+639171234567\",\n \"dateOfBirth\": \"1988-04-12\",\n \"governmentId\": \"P1234567\",\n \"governmentIdType\": \"PASSPORT\",\n \"governmentIdIssueCountry\": \"PHL\",\n \"nationality\": \"PHL\",\n \"occupation\": \"Software Engineer\",\n \"relationshipToCustomer\": \"SELF\",\n \"address\": {\n \"addressLine1\": \"12 Rizal Ave\",\n \"city\": \"Manila\",\n \"state\": \"Metro Manila\",\n \"country\": \"Philippines\",\n \"postalCode\": \"1000\",\n \"countryThreeLetter\": \"PHL\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-sandbox.endl.io/api/v0/pobo/senders")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"Maria\",\n \"lastName\": \"Santos\",\n \"email\": \"maria.santos@example.com\",\n \"phone\": \"+639171234567\",\n \"dateOfBirth\": \"1988-04-12\",\n \"governmentId\": \"P1234567\",\n \"governmentIdType\": \"PASSPORT\",\n \"governmentIdIssueCountry\": \"PHL\",\n \"nationality\": \"PHL\",\n \"occupation\": \"Software Engineer\",\n \"relationshipToCustomer\": \"SELF\",\n \"address\": {\n \"addressLine1\": \"12 Rizal Ave\",\n \"city\": \"Manila\",\n \"state\": \"Metro Manila\",\n \"country\": \"Philippines\",\n \"postalCode\": \"1000\",\n \"countryThreeLetter\": \"PHL\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.endl.io/api/v0/pobo/senders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"Maria\",\n \"lastName\": \"Santos\",\n \"email\": \"maria.santos@example.com\",\n \"phone\": \"+639171234567\",\n \"dateOfBirth\": \"1988-04-12\",\n \"governmentId\": \"P1234567\",\n \"governmentIdType\": \"PASSPORT\",\n \"governmentIdIssueCountry\": \"PHL\",\n \"nationality\": \"PHL\",\n \"occupation\": \"Software Engineer\",\n \"relationshipToCustomer\": \"SELF\",\n \"address\": {\n \"addressLine1\": \"12 Rizal Ave\",\n \"city\": \"Manila\",\n \"state\": \"Metro Manila\",\n \"country\": \"Philippines\",\n \"postalCode\": \"1000\",\n \"countryThreeLetter\": \"PHL\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 201,
"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": 409,
"message": "A sender with this governmentId already exists for this partner",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "CONFLICT",
"message": "A sender with this governmentId already exists for this partner",
"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
}Create a POBO sender — the originator a payment is made on behalf of.
type is INDIVIDUAL or BUSINESS; a business carries its name in businessName.
Before a sender can be used for a payout it needs a name, a governmentId, and address.country. A duplicate governmentId for the same partner is rejected with 409.
The response returns a snd_ reference id — that is the senderId every POBO transaction requires.
POST
/
api
/
v0
/
pobo
/
senders
Create sender
curl --request POST \
--url https://api-sandbox.endl.io/api/v0/pobo/senders \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "INDIVIDUAL",
"firstName": "Maria",
"lastName": "Santos",
"email": "maria.santos@example.com",
"phone": "+639171234567",
"dateOfBirth": "1988-04-12",
"governmentId": "P1234567",
"governmentIdType": "PASSPORT",
"governmentIdIssueCountry": "PHL",
"nationality": "PHL",
"occupation": "Software Engineer",
"relationshipToCustomer": "SELF",
"address": {
"addressLine1": "12 Rizal Ave",
"city": "Manila",
"state": "Metro Manila",
"country": "Philippines",
"postalCode": "1000",
"countryThreeLetter": "PHL"
}
}
'import requests
url = "https://api-sandbox.endl.io/api/v0/pobo/senders"
payload = {
"type": "INDIVIDUAL",
"firstName": "Maria",
"lastName": "Santos",
"email": "maria.santos@example.com",
"phone": "+639171234567",
"dateOfBirth": "1988-04-12",
"governmentId": "P1234567",
"governmentIdType": "PASSPORT",
"governmentIdIssueCountry": "PHL",
"nationality": "PHL",
"occupation": "Software Engineer",
"relationshipToCustomer": "SELF",
"address": {
"addressLine1": "12 Rizal Ave",
"city": "Manila",
"state": "Metro Manila",
"country": "Philippines",
"postalCode": "1000",
"countryThreeLetter": "PHL"
}
}
headers = {
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'INDIVIDUAL',
firstName: 'Maria',
lastName: 'Santos',
email: 'maria.santos@example.com',
phone: '+639171234567',
dateOfBirth: '1988-04-12',
governmentId: 'P1234567',
governmentIdType: 'PASSPORT',
governmentIdIssueCountry: 'PHL',
nationality: 'PHL',
occupation: 'Software Engineer',
relationshipToCustomer: 'SELF',
address: {
addressLine1: '12 Rizal Ave',
city: 'Manila',
state: 'Metro Manila',
country: 'Philippines',
postalCode: '1000',
countryThreeLetter: 'PHL'
}
})
};
fetch('https://api-sandbox.endl.io/api/v0/pobo/senders', 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/senders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'INDIVIDUAL',
'firstName' => 'Maria',
'lastName' => 'Santos',
'email' => 'maria.santos@example.com',
'phone' => '+639171234567',
'dateOfBirth' => '1988-04-12',
'governmentId' => 'P1234567',
'governmentIdType' => 'PASSPORT',
'governmentIdIssueCountry' => 'PHL',
'nationality' => 'PHL',
'occupation' => 'Software Engineer',
'relationshipToCustomer' => 'SELF',
'address' => [
'addressLine1' => '12 Rizal Ave',
'city' => 'Manila',
'state' => 'Metro Manila',
'country' => 'Philippines',
'postalCode' => '1000',
'countryThreeLetter' => 'PHL'
]
]),
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/senders"
payload := strings.NewReader("{\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"Maria\",\n \"lastName\": \"Santos\",\n \"email\": \"maria.santos@example.com\",\n \"phone\": \"+639171234567\",\n \"dateOfBirth\": \"1988-04-12\",\n \"governmentId\": \"P1234567\",\n \"governmentIdType\": \"PASSPORT\",\n \"governmentIdIssueCountry\": \"PHL\",\n \"nationality\": \"PHL\",\n \"occupation\": \"Software Engineer\",\n \"relationshipToCustomer\": \"SELF\",\n \"address\": {\n \"addressLine1\": \"12 Rizal Ave\",\n \"city\": \"Manila\",\n \"state\": \"Metro Manila\",\n \"country\": \"Philippines\",\n \"postalCode\": \"1000\",\n \"countryThreeLetter\": \"PHL\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-sandbox.endl.io/api/v0/pobo/senders")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"Maria\",\n \"lastName\": \"Santos\",\n \"email\": \"maria.santos@example.com\",\n \"phone\": \"+639171234567\",\n \"dateOfBirth\": \"1988-04-12\",\n \"governmentId\": \"P1234567\",\n \"governmentIdType\": \"PASSPORT\",\n \"governmentIdIssueCountry\": \"PHL\",\n \"nationality\": \"PHL\",\n \"occupation\": \"Software Engineer\",\n \"relationshipToCustomer\": \"SELF\",\n \"address\": {\n \"addressLine1\": \"12 Rizal Ave\",\n \"city\": \"Manila\",\n \"state\": \"Metro Manila\",\n \"country\": \"Philippines\",\n \"postalCode\": \"1000\",\n \"countryThreeLetter\": \"PHL\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.endl.io/api/v0/pobo/senders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"INDIVIDUAL\",\n \"firstName\": \"Maria\",\n \"lastName\": \"Santos\",\n \"email\": \"maria.santos@example.com\",\n \"phone\": \"+639171234567\",\n \"dateOfBirth\": \"1988-04-12\",\n \"governmentId\": \"P1234567\",\n \"governmentIdType\": \"PASSPORT\",\n \"governmentIdIssueCountry\": \"PHL\",\n \"nationality\": \"PHL\",\n \"occupation\": \"Software Engineer\",\n \"relationshipToCustomer\": \"SELF\",\n \"address\": {\n \"addressLine1\": \"12 Rizal Ave\",\n \"city\": \"Manila\",\n \"state\": \"Metro Manila\",\n \"country\": \"Philippines\",\n \"postalCode\": \"1000\",\n \"countryThreeLetter\": \"PHL\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 201,
"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": 409,
"message": "A sender with this governmentId already exists for this partner",
"status": "ERROR",
"data": null,
"errors": [
{
"code": "CONFLICT",
"message": "A sender with this governmentId already exists for this partner",
"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
INDIVIDUAL or BUSINESS. A business carries its name in businessName.
Available options:
INDIVIDUAL, BUSINESS Given name. Individuals.
Family name. Individuals.
Registered name. Businesses.
Contact email.
Contact phone in E.164 — +639171234567.
Date of birth, YYYY-MM-DD.
Government identifier. Required before the sender can be used for a payout. Must be unique per partner — a duplicate is a 409.
Kind of identifier — for example PASSPORT.
ISO 3166-1 alpha-3 country that issued the id.
ISO 3166-1 alpha-3 nationality.
Occupation.
Relationship of this sender to your customer — SELF, for instance.
Postal address. countryThreeLetter is the ISO 3166-1 alpha-3 code.
Show child attributes
Show child attributes
Response
Sender created. data carries the snd_ reference id.