GET
/
v1
/
customers
/
{customerId}
/
beneficiaries
List beneficiaries
curl --request GET \
  --url https://api.next.orenda.finance/v1/customers/{customerId}/beneficiaries \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.next.orenda.finance/v1/customers/{customerId}/beneficiaries"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.next.orenda.finance/v1/customers/{customerId}/beneficiaries', 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.next.orenda.finance/v1/customers/{customerId}/beneficiaries",
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>"
],
]);

$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.next.orenda.finance/v1/customers/{customerId}/beneficiaries"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

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.next.orenda.finance/v1/customers/{customerId}/beneficiaries")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.next.orenda.finance/v1/customers/{customerId}/beneficiaries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": [
    {
      "id": "ben_4b8e1c9d",
      "customerId": "cust_3f9a2b7e",
      "accountId": "acc_7c1d8e4a",
      "name": "Ada Lovelace",
      "account": {
        "type": "uk",
        "sortCode": "040506",
        "accountNumber": "87654321"
      },
      "type": "LOCAL_BENEFICIARY",
      "status": "ACTIVE",
      "providerId": "prv_a1b2c3d4",
      "accountType": "CONSUMER",
      "isCorporate": false,
      "currency": "GBP"
    },
    {
      "id": "ben_9f2c1a7b",
      "customerId": "cust_3f9a2b7e",
      "accountId": "acc_7c1d8e4a",
      "name": "Grace Hopper",
      "account": {
        "type": "iban",
        "iban": "FR7630006000011234567890189",
        "bic": "AGRIFRPP"
      },
      "type": "LOCAL_BENEFICIARY",
      "status": "ACTIVE",
      "providerId": "prv_e5f6a7b8",
      "accountType": "CONSUMER",
      "isCorporate": false,
      "currency": "EUR"
    }
  ],
  "nextToken": "eyJpZCI6ImJlbl85ZjJjMWE3YiJ9"
}
{
"success": false,
"code": "<string>",
"message": "<string>"
}
Returns the customer’s payees, newest first. Page through them with limit and the nextToken from the previous response.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId
string
required

The customer's id. It's the customerId from the signed-in user's application (the onboarding response, also returned on the customer's accounts).

Query Parameters

limit
integer
nextToken
string

From the previous page's response.

Response

Beneficiaries

success
boolean
Example:

true

data
object[]
nextToken
string

Pass to the next request to get the next page. Absent on the last page.