List user recipient book
curl --request GET \
--url https://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/recipients \
--header 'X-API-Key: <api-key>'import requests
url = "https://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/recipients"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/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://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/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 => [
"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://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/recipients"
req, _ := http.NewRequest("GET", url, nil)
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://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/recipients")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"recipientKey": "fp_9a3c1d5e9f02b4d6e8f01a2b",
"name": {
"firstName": "Juan",
"lastName": "Perez",
"middleName": "Carlos",
"secondLastName": "Gomez"
},
"lastUsedAt": "2026-07-01T12:00:00.000Z",
"timesUsed": 7,
"destinations": [
{
"payoutMethod": "CASH_PICKUP",
"lastUsedAt": "2026-07-01T12:00:00.000Z",
"timesUsed": 5,
"cash": {
"stateCode": "MX-CMX",
"payerCode": "OXXO"
},
"paymentMethodId": "pm_ba_8a3c1d5e9f02",
"display": {
"bankName": "BBVA",
"maskedAccount": "····1234",
"cardBrand": "visa",
"cardLast4": "4242"
},
"phone": "+5213312345678",
"lastCapabilityKey": "US:MX:CRB_INTERMEX:CASH_PICKUP:MX-CMX:ANY:OXXO"
}
],
"address": {
"countryISO2": "MX",
"state": "MX-JAL",
"city": "Guadalajara",
"line1": "Av. Juarez 123",
"zip": "44100"
},
"phone": "+5213312345678"
}
]Partner - Users
List user recipient book
Derived read model — aggregates the user’s own operations by recipient fingerprint (no separate collection). Each entry carries destinations[] with habitual payout arrangements (cash hints, stored instruments, wallet phones).
GET
/
partner
/
users
/
{userId}
/
recipients
List user recipient book
curl --request GET \
--url https://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/recipients \
--header 'X-API-Key: <api-key>'import requests
url = "https://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/recipients"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/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://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/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 => [
"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://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/recipients"
req, _ := http.NewRequest("GET", url, nil)
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://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/recipients")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://raas-widgets-backend-sandbox.up.railway.app/partner/users/{userId}/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"recipientKey": "fp_9a3c1d5e9f02b4d6e8f01a2b",
"name": {
"firstName": "Juan",
"lastName": "Perez",
"middleName": "Carlos",
"secondLastName": "Gomez"
},
"lastUsedAt": "2026-07-01T12:00:00.000Z",
"timesUsed": 7,
"destinations": [
{
"payoutMethod": "CASH_PICKUP",
"lastUsedAt": "2026-07-01T12:00:00.000Z",
"timesUsed": 5,
"cash": {
"stateCode": "MX-CMX",
"payerCode": "OXXO"
},
"paymentMethodId": "pm_ba_8a3c1d5e9f02",
"display": {
"bankName": "BBVA",
"maskedAccount": "····1234",
"cardBrand": "visa",
"cardLast4": "4242"
},
"phone": "+5213312345678",
"lastCapabilityKey": "US:MX:CRB_INTERMEX:CASH_PICKUP:MX-CMX:ANY:OXXO"
}
],
"address": {
"countryISO2": "MX",
"state": "MX-JAL",
"city": "Guadalajara",
"line1": "Av. Juarez 123",
"zip": "44100"
},
"phone": "+5213312345678"
}
]Authorizations
Your partner API key. Use raas_sandbox_* keys for the sandbox environment and raas_live_* keys for production.
Path Parameters
M2M user identifier
Example:
"user_acme_x1y2z3"
Query Parameters
Max recipients returned (1-50, default 50)
Example:
50
Response
Recent recipients retrieved successfully
Stable aggregation key (recipient fingerprint)
Example:
"fp_9a3c1d5e9f02b4d6e8f01a2b"
Show child attributes
Show child attributes
Example:
"2026-07-01T12:00:00.000Z"
Example:
7
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"+5213312345678"
⌘I