Community Federal Savings Bank
API docs by Redocly

Accounts API Docs (v1.12.12)

Download OpenAPI specification:Download

AccountEntityRelationships

/api/AccountEntityRelationships/ByAccount/{accountId}

path Parameters
accountId
required
string <uuid>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": [
    ]
}

/api/AccountEntityRelationships

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
accountID
string or null <uuid>
entityID
string or null <uuid>
relationshipCode
string (AccountEntityRelationshipCodes)
Enum: "AR" "CP" "BO" "DI" "SO" "Borrower" "CoBorrower"

AR - Authorized Representative CP - Control Person BO - BeneficialOwner DI - Director SO - SigningOfficer Borrower - Borrower CoBorrower - CoBorrower

ownershipPercent
number or null <double> [ 0 .. 100 ]
authorizedSignerInd
boolean
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "accountID": "1234567890",
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "relationshipCode": "AR",
  • "ownershipPercent": 49.5,
  • "authorizedSignerInd": true,
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z",
  • "partnerID": "ae461794-a7aa-4a5a-a2ed-164bbc7dd251"
}

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": "808ac6e4-93ed-4040-85a5-6c71a2444e90"
}

/api/AccountEntityRelationships

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
accountEntityRelationshipID
string <uuid>
relationshipCode
string (AccountEntityRelationshipCodes)
Enum: "AR" "CP" "BO" "DI" "SO" "Borrower" "CoBorrower"

AR - Authorized Representative CP - Control Person BO - BeneficialOwner DI - Director SO - SigningOfficer Borrower - Borrower CoBorrower - CoBorrower

ownershipPercent
number or null <double> [ 0 .. 100 ]
authorizedSignerInd
boolean or null
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "accountEntityRelationshipID": "a48a2aab-080a-4331-96fa-dbda66158c45",
  • "relationshipCode": "AR",
  • "ownershipPercent": 49.5,
  • "authorizedSignerInd": true,
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string"
}

/api/AccountEntityRelationships/{id}

path Parameters
id
required
string <uuid>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": {
    }
}

Accounts

/api/Accounts/Validate

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
accountNumber
required
string [ 10 .. 18 ] characters
railID
required
string (RailTypes)
Enum: "ACH" "FEDWIRE" "TCH" "FEDNOW" "SWIFTWIRE"

Responses

Request samples

Content type
{
  • "accountNumber": "stringstri",
  • "railID": "ACH"
}

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": {
    }
}

/api/Accounts/ByPartner/{partnerId}

path Parameters
partnerId
required
string <uuid>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": [
    ]
}

/api/Accounts

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
accountNumber
string or null [ 10 .. 18 ] characters

Virtual account number. This can either be assigned by the partner, or created on POST ACCOUNT call, if an account number is not provided.

The prefixes must be validated. (Partner and Product).

621-012-123456789012

Where 621 = PartnerAccountPrefix from Partner 012 = ProductAccountPrefix from Product) 123456789012 = account number

masterAccountID
string <= 14 characters
subAccountInd
boolean
productID
string <uuid>
accountStatus
string (AccountStatuses)
Enum: "Inactive" "Active" "Closed" "OnHold" "Dormant" "ChargedOff" "OriginationsResrticted" "ReceivedRestricted" "AllTransactionsRestricted"
merchantId
string or null <= 10 characters
openedAtUtcDt
string <date-time>
closedAtUtcDt
string or null <date-time>
accountPurpose
string (AccountPurposes)
Enum: "Investment" "Home" "Retirement" "DailyBanking" "Vehicle" "Leisure" "Education" "Emergency" "Taxes"
accountTitle
string <= 100 characters
accountType
string (AccountTypes)
Enum: "VA" "CHK" "SAV" "MMK" "TD"
accountClassification
string (AccountClassifications)
Enum: "Personal" "Business"
accountFlexFields
string or null
Array of objects (CreateNestedAccountEntityRelationship)
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "accountNumber": "1234567890",
  • "masterAccountID": "1234567890",
  • "subAccountInd": true,
  • "productID": "dbb08e34-cbbb-47d7-824b-bc71f5b00e6c",
  • "accountStatus": "Inactive",
  • "merchantId": "ABCD345678",
  • "openedAtUtcDt": "2019-08-24T14:15:22Z",
  • "closedAtUtcDt": "2019-08-24T14:15:22Z",
  • "accountPurpose": "Investment",
  • "accountTitle": "Savings for vacation",
  • "accountType": "VA",
  • "accountClassification": "Personal",
  • "accountFlexFields": "{ \"field1\": \"field value\", \"field2\": 123 }",
  • "accountEntityRelationships": [
    ],
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z",
  • "partnerID": "ae461794-a7aa-4a5a-a2ed-164bbc7dd251"
}

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": "808ac6e4-93ed-4040-85a5-6c71a2444e90"
}

/api/Accounts

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
accountStatus
string (AccountStatuses)
Enum: "Inactive" "Active" "Closed" "OnHold" "Dormant" "ChargedOff" "OriginationsResrticted" "ReceivedRestricted" "AllTransactionsRestricted"
accountPurpose
string (AccountPurposes)
Enum: "Investment" "Home" "Retirement" "DailyBanking" "Vehicle" "Leisure" "Education" "Emergency" "Taxes"
accountTitle
string or null <= 100 characters
accountType
string (AccountTypes)
Enum: "VA" "CHK" "SAV" "MMK" "TD"
accountClassification
string (AccountClassifications)
Enum: "Personal" "Business"
accountFlexFields
string or null
Array of objects or null (UpdateAccountEntityRelationship)
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "accountStatus": "Inactive",
  • "accountPurpose": "Investment",
  • "accountTitle": "Savings for vacation",
  • "accountType": "VA",
  • "accountClassification": "Personal",
  • "accountFlexFields": "{ \"field1\": \"field value\", \"field2\": 123 }",
  • "accountEntityRelationships": [
    ],
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string"
}

/api/Accounts/{id}

path Parameters
id
required
string <uuid>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": {
    }
}