Create pre-transaction
curl --request POST \
--url https://api-sandbox.endl.io/api/v0/pobo/transactions/pre-txn \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"quoteId": "qut_xxxxxxxxxxxxxxxxxxxx",
"recipientId": "rec_xxxxxxxxxxxxxxxxxxxx",
"senderId": "snd_xxxxxxxxxxxxxxxxxxxx",
"transferPurposeCode": "FAMILY_SUPPORT"
}
'import requests
url = "https://api-sandbox.endl.io/api/v0/pobo/transactions/pre-txn"
payload = {
"quoteId": "qut_xxxxxxxxxxxxxxxxxxxx",
"recipientId": "rec_xxxxxxxxxxxxxxxxxxxx",
"senderId": "snd_xxxxxxxxxxxxxxxxxxxx",
"transferPurposeCode": "FAMILY_SUPPORT"
}
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({
quoteId: 'qut_xxxxxxxxxxxxxxxxxxxx',
recipientId: 'rec_xxxxxxxxxxxxxxxxxxxx',
senderId: 'snd_xxxxxxxxxxxxxxxxxxxx',
transferPurposeCode: 'FAMILY_SUPPORT'
})
};
fetch('https://api-sandbox.endl.io/api/v0/pobo/transactions/pre-txn', 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/transactions/pre-txn",
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([
'quoteId' => 'qut_xxxxxxxxxxxxxxxxxxxx',
'recipientId' => 'rec_xxxxxxxxxxxxxxxxxxxx',
'senderId' => 'snd_xxxxxxxxxxxxxxxxxxxx',
'transferPurposeCode' => 'FAMILY_SUPPORT'
]),
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/transactions/pre-txn"
payload := strings.NewReader("{\n \"quoteId\": \"qut_xxxxxxxxxxxxxxxxxxxx\",\n \"recipientId\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"senderId\": \"snd_xxxxxxxxxxxxxxxxxxxx\",\n \"transferPurposeCode\": \"FAMILY_SUPPORT\"\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/transactions/pre-txn")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"quoteId\": \"qut_xxxxxxxxxxxxxxxxxxxx\",\n \"recipientId\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"senderId\": \"snd_xxxxxxxxxxxxxxxxxxxx\",\n \"transferPurposeCode\": \"FAMILY_SUPPORT\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.endl.io/api/v0/pobo/transactions/pre-txn")
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 \"quoteId\": \"qut_xxxxxxxxxxxxxxxxxxxx\",\n \"recipientId\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"senderId\": \"snd_xxxxxxxxxxxxxxxxxxxx\",\n \"transferPurposeCode\": \"FAMILY_SUPPORT\"\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
}Lock a quote in and receive deposit instructions for the transfer.
senderId is mandatory on every POBO transaction. That is the whole point of the surface: the payment is made on behalf of a named originator.
POST
/
api
/
v0
/
pobo
/
transactions
/
pre-txn
Create pre-transaction
curl --request POST \
--url https://api-sandbox.endl.io/api/v0/pobo/transactions/pre-txn \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"quoteId": "qut_xxxxxxxxxxxxxxxxxxxx",
"recipientId": "rec_xxxxxxxxxxxxxxxxxxxx",
"senderId": "snd_xxxxxxxxxxxxxxxxxxxx",
"transferPurposeCode": "FAMILY_SUPPORT"
}
'import requests
url = "https://api-sandbox.endl.io/api/v0/pobo/transactions/pre-txn"
payload = {
"quoteId": "qut_xxxxxxxxxxxxxxxxxxxx",
"recipientId": "rec_xxxxxxxxxxxxxxxxxxxx",
"senderId": "snd_xxxxxxxxxxxxxxxxxxxx",
"transferPurposeCode": "FAMILY_SUPPORT"
}
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({
quoteId: 'qut_xxxxxxxxxxxxxxxxxxxx',
recipientId: 'rec_xxxxxxxxxxxxxxxxxxxx',
senderId: 'snd_xxxxxxxxxxxxxxxxxxxx',
transferPurposeCode: 'FAMILY_SUPPORT'
})
};
fetch('https://api-sandbox.endl.io/api/v0/pobo/transactions/pre-txn', 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/transactions/pre-txn",
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([
'quoteId' => 'qut_xxxxxxxxxxxxxxxxxxxx',
'recipientId' => 'rec_xxxxxxxxxxxxxxxxxxxx',
'senderId' => 'snd_xxxxxxxxxxxxxxxxxxxx',
'transferPurposeCode' => 'FAMILY_SUPPORT'
]),
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/transactions/pre-txn"
payload := strings.NewReader("{\n \"quoteId\": \"qut_xxxxxxxxxxxxxxxxxxxx\",\n \"recipientId\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"senderId\": \"snd_xxxxxxxxxxxxxxxxxxxx\",\n \"transferPurposeCode\": \"FAMILY_SUPPORT\"\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/transactions/pre-txn")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"quoteId\": \"qut_xxxxxxxxxxxxxxxxxxxx\",\n \"recipientId\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"senderId\": \"snd_xxxxxxxxxxxxxxxxxxxx\",\n \"transferPurposeCode\": \"FAMILY_SUPPORT\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.endl.io/api/v0/pobo/transactions/pre-txn")
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 \"quoteId\": \"qut_xxxxxxxxxxxxxxxxxxxx\",\n \"recipientId\": \"rec_xxxxxxxxxxxxxxxxxxxx\",\n \"senderId\": \"snd_xxxxxxxxxxxxxxxxxxxx\",\n \"transferPurposeCode\": \"FAMILY_SUPPORT\"\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
Response
Deposit instructions for the transfer.