List bank accounts

GET

beneficiaries

{id}

bank-accounts

List a Beneficiary’s bank accounts (masked)

curl --request GET \
  --url https://api.example.com/v1/beneficiaries/{id}/bank-accounts \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/v1/beneficiaries/{id}/bank-accounts"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/beneficiaries/{id}/bank-accounts', 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.example.com/v1/beneficiaries/{id}/bank-accounts",
  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.example.com/v1/beneficiaries/{id}/bank-accounts"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/beneficiaries/{id}/bank-accounts")

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

{
  "bank_accounts": [
    {
      "id": "<string>",
      "account_holder_name": "<string>",
      "currency": "<string>",
      "country": "<string>",
      "status": "verified",
      "validation_status": "unvalidated",
      "payout_usable": true,
      "last4": "<string>",
      "account_type": "checking",
      "rail_rejection_reason": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Cleff API key issued to a Business that self-registers via POST /v1/registration

Path Parameters

string

required

Response

bank_accounts

object[]

required

Show child attributes

⌘I

List a Beneficiary’s bank accounts (masked)

curl --request GET \
  --url https://api.example.com/v1/beneficiaries/{id}/bank-accounts \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/v1/beneficiaries/{id}/bank-accounts"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/beneficiaries/{id}/bank-accounts', 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.example.com/v1/beneficiaries/{id}/bank-accounts",
  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.example.com/v1/beneficiaries/{id}/bank-accounts"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/beneficiaries/{id}/bank-accounts")

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

{
  "bank_accounts": [
    {
      "id": "<string>",
      "account_holder_name": "<string>",
      "currency": "<string>",
      "country": "<string>",
      "status": "verified",
      "validation_status": "unvalidated",
      "payout_usable": true,
      "last4": "<string>",
      "account_type": "checking",
      "rail_rejection_reason": {}
    }
  ]
}

Basics

Reference

List bank accounts

Authorizations

Path Parameters

Response