Recipients
List recipients
List the recipients you have saved for one user.
user_id is required: this call always answers for a single user, never for your whole account.
GET
/
v1
/
recipients
cURL
curl --request GET \
--url 'https://api.balampay.com/sandbox/v1/recipients?user_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.balampay.com/sandbox/v1/recipients"
headers = {
"Authorization": "Bearer <token>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'x-api-key': '<api-key>'}
};
fetch('https://api.balampay.com/sandbox/v1/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.balampay.com/sandbox/v1/recipients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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"
"net/http"
"io"
)
func main() {
url := "https://api.balampay.com/sandbox/v1/recipients"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.balampay.com/sandbox/v1/recipients")
.header("Authorization", "Bearer <token>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.balampay.com/sandbox/v1/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"recipients": [
{
"recipient_id": "cccccccc-dddd-eeee-ffff-000000000000",
"type": "business",
"company_name": "Acme Supplies LLC",
"email": "ap@example.com",
"address": {
"street_name": "500 Howard Street",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "US"
},
"account_type": "WIRE",
"account_details": {
"routing_number": "000000001",
"account_number": "1000000001",
"type": "checking",
"bank_name": "Example Bank National Association",
"bank_address": {
"street_name": "1 Second Street South",
"city": "St. Cloud",
"state": "MN",
"postal_code": "56301",
"country": "US"
},
"doc_type": "ein",
"doc_number": "123456789"
},
"created_ts": "2026-09-01T12:00:00.000Z",
"updated_ts": "2026-09-01T12:00:00.000Z",
"metadata": {}
},
{
"recipient_id": "eeeeeeee-ffff-0000-1111-222222222222",
"type": "individual",
"first_name": "Alice",
"last_name": "Smith",
"account_type": "WALLET",
"account_details": {
"token": "USDC",
"address": "0x0000000000000000000000000000000000000001",
"network": "polygon"
},
"created_ts": "2026-09-02T09:30:00.000Z",
"updated_ts": "2026-09-02T09:30:00.000Z",
"metadata": {
"ledger_ref": "op-4471"
}
}
],
"total": 2
}Headers
Version applied to this request. It wins over your account's pinned version — see Versioning.
Example:
"2026-04-14"
Query Parameters
The user whose recipients you want.
Example:
"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
Return only the recipients carrying the metadata you name, in the ?metadata[key]=value form. Pass more than one key to require all of them.
Each key is 1 to 40 characters and cannot contain [ or ].
⌘I
cURL
curl --request GET \
--url 'https://api.balampay.com/sandbox/v1/recipients?user_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.balampay.com/sandbox/v1/recipients"
headers = {
"Authorization": "Bearer <token>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'x-api-key': '<api-key>'}
};
fetch('https://api.balampay.com/sandbox/v1/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.balampay.com/sandbox/v1/recipients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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"
"net/http"
"io"
)
func main() {
url := "https://api.balampay.com/sandbox/v1/recipients"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.balampay.com/sandbox/v1/recipients")
.header("Authorization", "Bearer <token>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.balampay.com/sandbox/v1/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"recipients": [
{
"recipient_id": "cccccccc-dddd-eeee-ffff-000000000000",
"type": "business",
"company_name": "Acme Supplies LLC",
"email": "ap@example.com",
"address": {
"street_name": "500 Howard Street",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "US"
},
"account_type": "WIRE",
"account_details": {
"routing_number": "000000001",
"account_number": "1000000001",
"type": "checking",
"bank_name": "Example Bank National Association",
"bank_address": {
"street_name": "1 Second Street South",
"city": "St. Cloud",
"state": "MN",
"postal_code": "56301",
"country": "US"
},
"doc_type": "ein",
"doc_number": "123456789"
},
"created_ts": "2026-09-01T12:00:00.000Z",
"updated_ts": "2026-09-01T12:00:00.000Z",
"metadata": {}
},
{
"recipient_id": "eeeeeeee-ffff-0000-1111-222222222222",
"type": "individual",
"first_name": "Alice",
"last_name": "Smith",
"account_type": "WALLET",
"account_details": {
"token": "USDC",
"address": "0x0000000000000000000000000000000000000001",
"network": "polygon"
},
"created_ts": "2026-09-02T09:30:00.000Z",
"updated_ts": "2026-09-02T09:30:00.000Z",
"metadata": {
"ledger_ref": "op-4471"
}
}
],
"total": 2
}