Complete bank account linking
curl --request POST \
--url https://platform.spritz.finance/v1/bank-accounts/link-complete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"publicToken": "<string>",
"accountIds": [
"<string>"
],
"institutionId": "<string>",
"institutionName": "<string>"
}
'import requests
url = "https://platform.spritz.finance/v1/bank-accounts/link-complete"
payload = {
"publicToken": "<string>",
"accountIds": ["<string>"],
"institutionId": "<string>",
"institutionName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
publicToken: '<string>',
accountIds: ['<string>'],
institutionId: '<string>',
institutionName: '<string>'
})
};
fetch('https://platform.spritz.finance/v1/bank-accounts/link-complete', 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/link-complete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'publicToken' => '<string>',
'accountIds' => [
'<string>'
],
'institutionId' => '<string>',
'institutionName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.spritz.finance/v1/bank-accounts/link-complete"
payload := strings.NewReader("{\n \"publicToken\": \"<string>\",\n \"accountIds\": [\n \"<string>\"\n ],\n \"institutionId\": \"<string>\",\n \"institutionName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.spritz.finance/v1/bank-accounts/link-complete")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"publicToken\": \"<string>\",\n \"accountIds\": [\n \"<string>\"\n ],\n \"institutionId\": \"<string>\",\n \"institutionName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.spritz.finance/v1/bank-accounts/link-complete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"publicToken\": \"<string>\",\n \"accountIds\": [\n \"<string>\"\n ],\n \"institutionId\": \"<string>\",\n \"institutionName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"bankAccounts": [
{
"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": "Unauthorized",
"status": 400,
"type": "urn:problem-type:auth:unauthorized",
"detail": "<string>",
"instance": "/errors/1234567890",
"code": "transaction_limit",
"field": "amountUsd",
"retryable": true
}Bank Accounts
Complete bank account linking
Completes the Plaid Link flow by exchanging the public token, retrieving account details, and storing the linked bank accounts.
POST
/
v1
/
bank-accounts
/
link-complete
Complete bank account linking
curl --request POST \
--url https://platform.spritz.finance/v1/bank-accounts/link-complete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"publicToken": "<string>",
"accountIds": [
"<string>"
],
"institutionId": "<string>",
"institutionName": "<string>"
}
'import requests
url = "https://platform.spritz.finance/v1/bank-accounts/link-complete"
payload = {
"publicToken": "<string>",
"accountIds": ["<string>"],
"institutionId": "<string>",
"institutionName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
publicToken: '<string>',
accountIds: ['<string>'],
institutionId: '<string>',
institutionName: '<string>'
})
};
fetch('https://platform.spritz.finance/v1/bank-accounts/link-complete', 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/link-complete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'publicToken' => '<string>',
'accountIds' => [
'<string>'
],
'institutionId' => '<string>',
'institutionName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.spritz.finance/v1/bank-accounts/link-complete"
payload := strings.NewReader("{\n \"publicToken\": \"<string>\",\n \"accountIds\": [\n \"<string>\"\n ],\n \"institutionId\": \"<string>\",\n \"institutionName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.spritz.finance/v1/bank-accounts/link-complete")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"publicToken\": \"<string>\",\n \"accountIds\": [\n \"<string>\"\n ],\n \"institutionId\": \"<string>\",\n \"institutionName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.spritz.finance/v1/bank-accounts/link-complete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"publicToken\": \"<string>\",\n \"accountIds\": [\n \"<string>\"\n ],\n \"institutionId\": \"<string>\",\n \"institutionName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"bankAccounts": [
{
"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": "Unauthorized",
"status": 400,
"type": "urn:problem-type:auth:unauthorized",
"detail": "<string>",
"instance": "/errors/1234567890",
"code": "transaction_limit",
"field": "amountUsd",
"retryable": true
}Authorizations
bearerAuthintegratorJwthmacAuth & integratorKey & timestamp
Cognito JWT token for regular user authentication
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
Response for status 200
Bank accounts linked by this Plaid Link completion.
Bank account details. The type field indicates the account variant.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
⌘I