/CorrespondentInstructions - GET

get https://cubi-sandbox-api.customersbank.com/itoperations/v1/CorrespondentInstructions

Searches for known correspondence instructions (ssi) for various payment rails, given a target beneficiary bank (either ABA or BIC).
Will only return results for USD.
Banks may have multiple or zero results, and instructions should be validated with beneficiary banks prior to production usage

Responses

Response body

object

pageSize

int32

pageOffset

int32

totalPages

int32

totalItemCount

int32

items

array of objects

items

object

receiverAba

string | null

Routing number of the receiving bank. This must be a federal ABA number. If there is no intermediary bank, then this will be the ABA number of the beneficiary bank

receiverName

string | null

Name of receiving bank. If there is no intermediary bank, then this will be the name of the beneficiary bank

isPreferredSsi

boolean

Whether or not this is the preferred SSI for this bank. If multiple results are found, then those marked as preferred should be favored

clearingSystem

string | null

The clearing system for the correspondent instructions (SSI). Typically fedwire or ach, but could also be any foreign clearing system

intermediateLocationId

int64 | null

The location id of the intermediate bank location, if one exists

intermediateName

string | null

The name of the intermediary bank, if one exists

intermediateAddress

string | null

The street address of the intermediary bank, if one exists

intermediateCity

string | null

The city of the intermediary bank, if one exists

intermediateStateOrProvince

string | null

The state/province of the intermediary bank, if one exists

intermediatePostalCode

string | null

The postal code of the intermediary bank, if one exists

intermediateCountry

string | null

The country of the intermediary bank, if one exists

intermediateBic

string | null

The BIC of the intermediary bank, if one exists

intermediateAba

string | null

The ABA of the intermediary bank, if one exists

beneficiaryLocationId

int64

The location id of the beneficiary bank

beneficiaryName

string | null

The name of the benficiary bank

beneficiaryAddress

string | null

The street address of the beneficiary bank

beneficiaryCity

string | null

The city of the beneficiary bank

beneficiaryStateOrProvince

string | null

The state/province of the beneficiary bank

beneficiaryPostalCode

string | null

The postal code of the beneficiary bank

beneficiaryCountry

string | null

The country of the beneficiary bank

beneficiaryBic

string | null

The BIC of the beneficiary bank

alternateBeneficiaryBic

string | null

The Alternate BIC of the beneficiary bank (BIC-8)

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://cubi-sandbox-api.customersbank.com/itoperations/v1/CorrespondentInstructions \
3
     --header 'accept: application/json'


xxxxxxxxxx
32
}
1
{
2
  "pageSize": 0,
3
  "pageOffset": 0,
4
  "totalPages": 0,
5
  "totalItemCount": 0,
6
  "items": [
7
    {
8
      "receiverAba": "string",
9
      "receiverName": "string",
10
      "isPreferredSsi": true,
11
      "clearingSystem": "string",
12
      "intermediateLocationId": 0,
13
      "intermediateName": "string",
14
      "intermediateAddress": "string",
15
      "intermediateCity": "string",
16
      "intermediateStateOrProvince": "string",
17
      "intermediatePostalCode": "string",
18
      "intermediateCountry": "string",
19
      "intermediateBic": "string",
20
      "intermediateAba": "string",
21
      "beneficiaryLocationId": 0,
22
      "beneficiaryName": "string",
23
      "beneficiaryAddress": "string",
24
      "beneficiaryCity": "string",
25
      "beneficiaryStateOrProvince": "string",

200OK

400BadRequest

401Unauthorized

403Forbidden

422UnprocessableEntity

500InternalServerError