Skip to main content
Get all application beneficiaries
curl --request GET \
  --url https://api.yapily.com/applications/{applicationId}/beneficiaries \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api.yapily.com/applications/{applicationId}/beneficiaries"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.yapily.com/applications/{applicationId}/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.yapily.com/applications/{applicationId}/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: Basic <encoded-value>"
],
]);

$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.yapily.com/applications/{applicationId}/beneficiaries"

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

req.Header.Add("Authorization", "Basic <encoded-value>")

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.yapily.com/applications/{applicationId}/beneficiaries")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.yapily.com/applications/{applicationId}/beneficiaries")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "meta": {
    "tracingId": "<string>",
    "count": 123,
    "pagination": {
      "totalCount": 123,
      "self": {
        "from": "2023-11-07T05:31:56Z",
        "before": "2023-11-07T05:31:56Z",
        "limit": 123,
        "offset": 123,
        "cursor": "<string>"
      },
      "next": {
        "from": "2023-11-07T05:31:56Z",
        "before": "2023-11-07T05:31:56Z",
        "limit": 123,
        "cursor": "<string>"
      }
    }
  },
  "data": [
    {
      "beneficiaryId": "e7b7636d-a041-4013-8a1b-34dc85b7d341",
      "details": {
        "name": "John Doe",
        "accountIdentifier": {
          "type": "IBAN",
          "identification": "DE12345123451234512345123"
        }
      }
    }
  ]
}
{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 400,
"status": "BAD_REQUEST",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "BAD_REQUEST",
"code": 10600,
"message": "The server could not understand the request due to invalid syntax"
}
]
}
}
{
"error": {
"tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
"code": 400,
"status": "BAD_REQUEST",
"supportUrl": "https://support.yapily.com/",
"source": "YAPILY",
"issues": [
{
"type": "BAD_REQUEST",
"code": 10600,
"message": "The server could not understand the request due to invalid syntax"
}
]
}
}

Authorizations

Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Path Parameters

applicationId
string<uuid>
required

Yapily application Id

Example:

"6d97cf35-1000-4787-af16-7100912db9e4"

Response

OK

Application beneficiary paginated response.

meta
object
data
object[]