curl --request GET \
--url https://platform.spritz.finance/v1/bank-accounts/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform.spritz.finance/v1/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://platform.spritz.finance/v1/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://platform.spritz.finance/v1/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://platform.spritz.finance/v1/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))
}HttpResponse<String> response = Unirest.get("https://platform.spritz.finance/v1/bank-accounts/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.spritz.finance/v1/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[
{
"id": "ba_abc123",
"status": "active",
"statusReason": "account_invalid",
"accountHolderName": "John Doe",
"supportedRails": [
"ach_standard",
"rtp"
],
"createdAt": "2023-11-07T05:31:56Z",
"fundingSourceId": "<string>",
"type": "us",
"currency": "USD",
"accountNumberLast4": "6789",
"routingNumberLast4": "0021",
"institution": {
"name": "Chase",
"logo": "https://example.com/chase-logo.png"
},
"label": "Primary Checking",
"accountSubtype": "checking"
}
]{
"title": "Unauthorized",
"status": 401,
"type": "urn:problem-type:auth:unauthorized",
"detail": "Bearer token required",
"instance": "<string>",
"realm": "API",
"scope": "read:users"
}{
"title": "<string>",
"status": 404,
"resourceType": "user",
"resourceId": "<string>",
"type": "about:blank",
"detail": "<string>",
"instance": "<string>"
}{
"title": "Unauthorized",
"status": 400,
"type": "urn:problem-type:auth:unauthorized",
"detail": "<string>",
"instance": "/errors/1234567890",
"code": "transaction_limit",
"field": "amountUsd",
"retryable": true,
"retryAfter": 5,
"suggestedAction": "auto_ramp",
"clearsAt": "2023-11-07T05:31:56Z",
"availableAt": "2023-11-07T05:31:56Z",
"permanent": true
}List bank accounts
Returns all bank accounts for the authenticated user.
curl --request GET \
--url https://platform.spritz.finance/v1/bank-accounts/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform.spritz.finance/v1/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://platform.spritz.finance/v1/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://platform.spritz.finance/v1/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://platform.spritz.finance/v1/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))
}HttpResponse<String> response = Unirest.get("https://platform.spritz.finance/v1/bank-accounts/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.spritz.finance/v1/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[
{
"id": "ba_abc123",
"status": "active",
"statusReason": "account_invalid",
"accountHolderName": "John Doe",
"supportedRails": [
"ach_standard",
"rtp"
],
"createdAt": "2023-11-07T05:31:56Z",
"fundingSourceId": "<string>",
"type": "us",
"currency": "USD",
"accountNumberLast4": "6789",
"routingNumberLast4": "0021",
"institution": {
"name": "Chase",
"logo": "https://example.com/chase-logo.png"
},
"label": "Primary Checking",
"accountSubtype": "checking"
}
]{
"title": "Unauthorized",
"status": 401,
"type": "urn:problem-type:auth:unauthorized",
"detail": "Bearer token required",
"instance": "<string>",
"realm": "API",
"scope": "read:users"
}{
"title": "<string>",
"status": 404,
"resourceType": "user",
"resourceId": "<string>",
"type": "about:blank",
"detail": "<string>",
"instance": "<string>"
}{
"title": "Unauthorized",
"status": 400,
"type": "urn:problem-type:auth:unauthorized",
"detail": "<string>",
"instance": "/errors/1234567890",
"code": "transaction_limit",
"field": "amountUsd",
"retryable": true,
"retryAfter": 5,
"suggestedAction": "auto_ramp",
"clearsAt": "2023-11-07T05:31:56Z",
"availableAt": "2023-11-07T05:31:56Z",
"permanent": true
}Authorizations
User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.
Response
Response for status 200
- Option 1
- Option 2
- Option 3
- Option 4
Bank account details. The type field indicates the account variant.
Unique identifier for the bank account
"ba_abc123"
Whether the account can receive payouts. active is the only payable state; every other value means the account cannot be paid, and statusReason says why. Treat any value that is not active as unpayable rather than switching on the full list — new states may be added and will always follow that rule.
active, inactive "active"
Why the account cannot receive payouts. Always present when status is not active, and always null when it is.
account_invalid— the receiving bank does not recognise the account details.account_closed— the account has been closed at the bank.account_blocked— the bank will not accept credits to this account.not_supported— Spritz cannot pay accounts of this type or region.
All four are terminal: the account will not recover, so prompt the user to add a different one.
account_invalid, account_closed, account_blocked, not_supported, null "account_invalid"
Display name recorded on the user's bank account. This is not an ownership-match or eligibility decision.
"John Doe"
Payment rails available for this account
Fiat delivery rail.
ach_standard: ACH bank transfer, next business day.ach_same_day: ACH same-day transfer, delivered same business day.rtp: Real-time payment, seconds, 24/7.wire: Wire transfer, same/next day.eft: Electronic funds transfer, 1-2 business days.sepa: SEPA transfer (EU), 1-2 business days.faster_payments: UK Faster Payments, near-instant.push_to_card: Push to debit card, minutes.bill_pay: Bill payment rail.card_deposit: Deposit to crypto card.
ach_standard, ach_same_day, rtp, wire, eft, sepa, faster_payments, push_to_card, bill_pay, card_deposit ["ach_standard", "rtp"]
When the account was created
Associated opaque public funding source identifier, or null when no funding source exists for this bank account.
us USD Last 4 digits of account number
"6789"
Last 4 digits of routing number
"0021"
Financial institution details
Show child attributes
Show child attributes
Friendly name for the account
"Primary Checking"
Type of bank account (checking or savings)
checking, savings "checking"