List Bank Accounts (Receiver)

cURL

curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/accounts \
  --header 'partner-api-key: <api-key>'

import requests

url = "https://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/accounts"

headers = {"partner-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'partner-api-key': '<api-key>'}};

fetch('https://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/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://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/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 => [
    "partner-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://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/accounts"

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

	req.Header.Add("partner-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://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/accounts")
  .header("partner-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/accounts")

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

request = Net::HTTP::Get.new(url)
request["partner-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "count": 1,
    "total": 1,
    "data": [
      {
        "id": "string",
        "userId": "string",
        "partnerId": "string",
        "bankName": "string",
        "accountNumber": "string",
        "accountType": "SAVINGS",
        "clabe": "string",
        "country": "MX",
        "rampType": "ON_RAMP",
        "documentNumber": "string",
        "documentType": "PASSPORT",
        "alias": "string",
        "isVerified": true,
        "verificationStatus": "VERIFIED",
        "verifiedAt": "2025-05-14T10:05:00.000Z",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

GET

api

partner

banks

receivers

{receiverId}

accounts

cURL

curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/accounts \
  --header 'partner-api-key: <api-key>'

import requests

url = "https://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/accounts"

headers = {"partner-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'partner-api-key': '<api-key>'}};

fetch('https://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/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://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/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 => [
    "partner-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://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/accounts"

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

	req.Header.Add("partner-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://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/accounts")
  .header("partner-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging-api.capa.fi/api/partner/v2/banks/receivers/{receiverId}/accounts")

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

request = Net::HTTP::Get.new(url)
request["partner-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "count": 1,
    "total": 1,
    "data": [
      {
        "id": "string",
        "userId": "string",
        "partnerId": "string",
        "bankName": "string",
        "accountNumber": "string",
        "accountType": "SAVINGS",
        "clabe": "string",
        "country": "MX",
        "rampType": "ON_RAMP",
        "documentNumber": "string",
        "documentType": "PASSPORT",
        "alias": "string",
        "isVerified": true,
        "verificationStatus": "VERIFIED",
        "verifiedAt": "2025-05-14T10:05:00.000Z",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

Retrieves bank accounts for a user by receiver ID with pagination. Resolves the user from the receiver, then retrieves their bank accounts.

Error Codes

Common Errors

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”API Key is missing”
401	`UNAUTHORIZED`	”Invalid API Key format”
401	`UNAUTHORIZED`	”Invalid API Key”
403	`INVALID_PARTNER_FLOW`	”The partner has an invalid flow.”

User Ownership Errors

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”Partner information is required for this operation”
401	`UNAUTHORIZED`	”User is not associated with the partner”

Endpoint-Specific Errors

HTTP Status	Code	Message
400	`INVALID_USER_INPUT_ERROR`	”Invalid User Input”
404	`RECEIVER_NOT_FOUND`	”Receiver not found.”

Authorizations

partner-api-key

string

header

required

API key for the affiliated partner performing the request.

Path Parameters

receiverId

string

required

The receiver ID to get bank info for

Example:

"8374f327-38bd-4b0b-b8a7-2524599eb903"

Query Parameters

userId

string

User identifier

country

enum<string>

Country filter

Available options:

MX,

DO,

US,

AT,

BE,

BG,

HR,

CY,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

IS,

LI,

NO,

CH,

GB,

MC,

SM,

AD,

VA,

CN

rampType

enum<string>

Ramp type filter (ON_RAMP or OFF_RAMP)

Available options:

ON_RAMP,

OFF_RAMP,

CROSS_RAMP

string

User bank info ID to fetch a specific bank account

skip

number

The number of elements to exclude from the results.

limit

number

The maximum amount of results to return.

sortBy

string

Supported values:

createdAt

Response

Retrieves the bank accounts for a user by receiverId with pagination. First gets the user by receiver ID, then retrieves their bank accounts.

success

boolean

Example:

true

data

object

Show child attributes

Delete Bank Account (User)Add Bank Account (Receiver)

⌘I

​Error Codes

​Common Errors

​User Ownership Errors

​Endpoint-Specific Errors

Authorizations

Path Parameters

Query Parameters

Response

Error Codes

Common Errors

User Ownership Errors

Endpoint-Specific Errors