Exclude bank/account

API reference

Excludes either specific banks from an account's sweep or specific accounts from being swept at all.

Exclude banks from the sweep network Your customers may already have funds at a certain bank and this is a way to exclude that bank

Opt out of sweeps When a product is enabled for sweeps, all accounts created from that product are enrolled into the sweeps program. Use this endpoint to mark an account inactive for sweeps, effectively opting out for sweeps.

Endpoint: SweepsIntrafi/v1/accounts/{accountNumber}

PUT

https://sandbox.crbcos.com/SweepsIntrafi/v1/accounts/{accountNumber}

Path Parameters

accountNumberstringrequired
Description
Account number of account you want to make changes to

Body Parameters

statusstringrequired
Description
Set to "Active" to enroll this account in the sweeps program. Set to "Inactive" to opt this account out of the sweeps program.
bankExclusionsstring
Description
IDs of the banks to exclude from the network of banks where funds may be swept to

Response

accountNumberstring
Description
Account number
statusstring
Description
Inactive or Active
titlestring
Description
The name on the account. Usually this is the account holder name, but not always. 255 characters maximum.
bankExclusionsarray
Description
IDs of the banks to exclude from the network of banks where funds may be swept to
coreBalancestring
Description
Total available balance at Cross River
coreBalanceAsOfstring
Description
Date and time of the core balance. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
custodialBalanceinteger
Description
Total amount held at Cross River
networkBalanceinteger
Description
Total amount swept to IntraFi
networkBalanceAsOfstring
Description
Date and time of the network balance. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
maxSweepAmountinteger
Description
Max sweep amount will always be 0 as it refers to an override - program sweep limit is not reflected here
clientIdentifierstring
Description
Your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.
productIdstring
Description
ID in GUID format of your specific product type on which the account is based. Provided by Cross River.
partnerIdstring
Description
Your unique ID in the Cross River system. This ID is in GUID format.
openedAtstring
Description
Date and time the deposit account was opened. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
lastModifiedAtstring
Description
Internal Cross River value. Date and time the database entry was last modified. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
productNamestring
Description
Name associated with the product ID, for example, "Fintech123 checking product"
partnerNamestring
Description
Your partner name in the Cross River system

curl

curl --location --request PUT 'https://sandbox.crbcos.com/SweepsIntrafi/v1/accounts/2666129453' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
  "status": "Active",
  "bankExclusions": [ 
     "30895",
     "10015"
  ]
} '

nodejs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'PUT',
  'hostname': 'sandbox.crbcos.com',
  'path': '/SweepsIntrafi/v1/accounts/2666129453',
  'headers': {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "status": "Active",
  "bankExclusions": [
    "30895",
    "10015"
  ]
});

req.write(postData);

req.end();

python

import http.client
import json

conn = http.client.HTTPSConnection("sandbox.crbcos.com")
payload = json.dumps({
  "status": "Active",
  "bankExclusions": [
    "30895",
    "10015"
  ]
})
headers = {
  'Authorization': 'Bearer <token>',
  'Content-Type': 'application/json'
}
conn.request("PUT", "/SweepsIntrafi/v1/accounts/2666129453", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://sandbox.crbcos.com/SweepsIntrafi/v1/accounts/2666129453")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "status": "Active",
  "bankExclusions": [
    "30895",
    "10015"
  ]
})

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

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://sandbox.crbcos.com/SweepsIntrafi/v1/accounts/2666129453"
  method := "PUT"

  payload := strings.NewReader(`{
  "status": "Active",
  "bankExclusions": [ 
     "30895",
     "10015"
  ]
} `)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

200

{
  "accountNumber": "2666129453",
  "status": "Active",
  "title": "Sweeps Test 2",
  "bankExclusions": [
    "30895",
    "10015"
  ],
  "coreBalance": 125627321,
  "coreBalanceAsOf": "2024-09-25T16:17:20.1-04:00",
  "custodialBalance": 25627321,
  "networkBalance": 100000000,
  "networkBalanceAsOf": "2024-09-24T16:33:43.613-04:00",
  "maxSweepAmount": 0,
  "productId": "e4404005-03c1-4710-b759-b13700ebfac4",
  "partnerId": "6e6769ec-99e0-4c4f-8ae8-b13700eab0fc",
  "openedAt": "2024-05-14T16:26:10.227-04:00",
  "lastModifiedAt": "2024-09-25T16:18:48.5446146-04:00",
  "productName": "ibs Checking Product",
  "partnerName": "Ibrahim Saeed Partner"
}

404

{
  "message": "Ain't no cake like that."
}