Skip to main content
API docs by Redocly

BankRails API (1.0.11)

Download OpenAPI specification:Download

E-mail: apiteam@omfs.co.za License: Apache 2.0 Terms of Service

This API relates to API calls for the Bank Rails Systems.

Related Links:

External Documentation References to be added

clients

A client is an entity that can own one or multiple groups.

External Documentation References to be added

Adds a new client

Adds a new client

Authorizations:
api_key
header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string
Request Body schema: application/json

Adds a new client

client_id
integer
client_name
required
string
client_type
integer <int64>
Enum: 1 2

The type of client * 01 System Administrator * 02 Client

Responses

Request samples

Content type
application/json
{
  • "client_id": 10001,
  • "client_name": "A Client",
  • "client_type": 1
}

Response samples

Content type
application/json
{
  • "client_id": 10001
}

Updates client information

Updates a client

Authorizations:
api_key
path Parameters
client_id
required
integer

Numeric ID of the user to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string
Request Body schema: application/json

Updates a client

client_id
integer
client_name
required
string
client_type
integer <int64>
Enum: 1 2

The type of client * 01 System Administrator * 02 Client

Responses

Request samples

Content type
application/json
{
  • "client_id": 10001,
  • "client_name": "A Client",
  • "client_type": 1
}

Response samples

Content type
application/json
{
  • "client_id": 10001
}

Updates client information

Updates a client

Authorizations:
api_key
path Parameters
client_id
required
integer

Numeric ID of the user to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string
Request Body schema: application/json

Updates a client

client_id
integer
client_name
required
string
client_type
integer <int64>
Enum: 1 2

The type of client * 01 System Administrator * 02 Client

Responses

Request samples

Content type
application/json
{
  • "client_id": 10001,
  • "client_name": "A Client",
  • "client_type": 1
}

Response samples

Content type
application/json
{
  • "client_id": 10001
}

Get client information

Get client information

Authorizations:
api_key
path Parameters
client_id
required
integer

Numeric ID of the client to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string

Responses

Response samples

Content type
application/json
{
  • "client_id": 10001
}

Deletes client information

Updates a client

Authorizations:
api_key
path Parameters
client_id
required
integer

Numeric ID of the client to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string

Responses

Response samples

Content type
application/json
{
  • "client_id": 10001
}

Get client information

Get client information

Authorizations:
api_key
path Parameters
groupId
required
integer

Numeric ID of the client to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string

Responses

Response samples

Content type
application/json
{
  • "client_id": 10001,
  • "group_id": 1,
  • "group_name": "A Group"
}

Deletes client information

Deletes a group

Authorizations:
api_key
path Parameters
groupId
required
integer

Numeric ID of the group to delete

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string

Responses

Response samples

Content type
application/json
{
  • "client_id": 10001,
  • "group_id": 1
}

groups

A group defines a group of products

External Documentation References to be added

Adds a new group

Adds a new group

Authorizations:
api_key
header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string
Request Body schema: application/json

Adds a new group

client_id
required
integer
group_id
integer
group_name
required
string

Responses

Request samples

Content type
application/json
{
  • "client_id": 10001,
  • "group_id": 1,
  • "group_name": "A Group"
}

Response samples

Content type
application/json
{
  • "client_id": 10001,
  • "group_id": 1
}

Updates a group

Updates a group

Authorizations:
api_key
header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string
Request Body schema: application/json

Updates a client

client_id
required
integer
group_id
integer
group_name
required
string

Responses

Request samples

Content type
application/json
{
  • "client_id": 10001,
  • "group_id": 1,
  • "group_name": "A Group"
}

Response samples

Content type
application/json
{
  • "client_id": 10001,
  • "group_id": 1,
  • "group_name": "A Group"
}

Updates group information

Updates a group

Authorizations:
api_key
path Parameters
groupId
required
integer

Numeric ID of the user to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string
Request Body schema: application/json

Updates a group

client_id
required
integer
group_id
integer
group_name
required
string

Responses

Request samples

Content type
application/json
{
  • "client_id": 10001,
  • "group_id": 1,
  • "group_name": "A Group"
}

Response samples

Content type
application/json
{
  • "client_id": 10001,
  • "group_id": 1,
  • "group_name": "A Group"
}

Updates group information

Updates a group

Authorizations:
api_key
path Parameters
groupId
required
integer

Numeric ID of the user to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string
Request Body schema: application/json

Updates a group

client_id
required
integer
group_id
integer
group_name
required
string

Responses

Request samples

Content type
application/json
{
  • "client_id": 10001,
  • "group_id": 1,
  • "group_name": "A Group"
}

Response samples

Content type
application/json
{
  • "client_id": 10001,
  • "group_id": 1,
  • "group_name": "A Group"
}

products

A product is defined for a group, and which will determine the services to a customer

user

User management functions

customers

A customer is an entity that can have one or many accounts and is linked to a product

External Documentation References to be added

Updates a customers information

Updates the information for a customer

path Parameters
customerId
required
integer

Numeric ID of the user to get

Request Body schema: application/json

Updates customer information

customer_id
required
integer
customer_name
required
string
customer_type
required
integer <int64>
Enum: 1 2 10

The type of customer being Individual / Type of Business * 01 Individual * 02 Business

customer_id_type
required
integer <int64>
Enum: 1 2 3

Customer identity type being ID Number or registration number * 01 Identity Number * 02 Passport Number * 10 Business Registration Number

customer_id_number
required
string

Cutomer Identity number as identified by the the customer_id_type

customer_comments
string

Comments regarding the customer

user_id
integer

The user resposible for the entry, 0 for system or api

Responses

Request samples

Content type
application/json
{
  • "customer_id": 10001,
  • "customer_name": "A Person",
  • "customer_type": 1,
  • "customer_id_type": 1,
  • "customer_id_number": "0001010001081",
  • "customer_comments": "Comments",
  • "user_id": 0
}

Response samples

Content type
application/json
{
  • "api_result": {
    }
}

Deletes a customers information

path Parameters
customerId
required
integer

Numeric ID of the user to get

Responses

Response samples

Content type
application/json
{
  • "api_result": {
    }
}

Get a customer's accounts

Get a list of customer accounts

path Parameters
customer_id
required
integer

Numeric ID of the user

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a customers information

path Parameters
customer_id
required
integer

Numeric ID of the user to get

Responses

Response samples

Content type
application/json
{
  • "api_result": {
    }
}

Finds a customer

Finds the information for a customer

Request Body schema: application/json

Finds customer information

required
object (ApiResult)
object (CustomerID)

Responses

Request samples

Content type
application/json
{
  • "api_result": {
    },
  • "api_data": {
    }
}

Response samples

Content type
application/json
{
  • "api_result": {
    },
  • "api_data": {
    }
}

Finds a customer

Finds the information for a customer

Request Body schema: application/json

Finds customer information

required
object (ApiResult)
object (CustomerID)

Responses

Request samples

Content type
application/json
{
  • "api_result": {
    },
  • "api_data": {
    }
}

Response samples

Content type
application/json
{
  • "api_result": {
    },
  • "api_data": {
    }
}

Finds a customer

Finds the information for a customer

Request Body schema: application/json

Finds customer information

required
object (ApiResult)
object (CustomerID)

Responses

Request samples

Content type
application/json
{
  • "api_result": {
    },
  • "api_data": {
    }
}

Response samples

Content type
application/json
{
  • "api_result": {
    },
  • "api_data": {
    }
}

Get information outstanding for customer

Gets a list of information outstanding for the customer to be administratively complete

Request Body schema:

Gets a list of outstanding customer information

customer_id
required
integer

Responses

Request samples

Content type
{
  • "customer_id": 10001
}

Response samples

Content type
{
  • "customer_id": 10001,
  • "documentation_array": "string"
}

accounts

An account that stored customer transactions and value

External Documentation References to be added

Get a customer's accounts

Get a list of customer accounts

path Parameters
customer_id
required
integer

Numeric ID of the user

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new account

Adds a new account

Request Body schema:

Adds a new account

branchCode
required
string

The customer id is a value assigned by the system identifying the customer.

accountNumber
required
string
accountStatusId
integer
accountStatus
required
string
customerId
integer
productId
integer <int64>

The product this account belongs to

accountName
required
any <string>

Account name

currencyCode
any <integer>

Base currency for the account

userId
integer

The user resposible for the entry, 0 for system or api

Responses

Request samples

Content type
{
  • "branchCode": 10001,
  • "accountNumber": "12345678901",
  • "accountStatusId": 0,
  • "accountStatus": "string",
  • "customerId": 10000,
  • "productId": 1,
  • "accountName": "A Person",
  • "currencyCode": 740,
  • "userId": 0
}

Response samples

Content type
{
  • "branchCode": 10001,
  • "accountNumber": "12345678901",
  • "accountStatusId": 0,
  • "accountStatus": "string",
  • "customerId": 10000,
  • "productId": 1,
  • "accountName": "A Person",
  • "currencyCode": 740,
  • "userId": 0
}

Updates account information

Updates an account

Request Body schema:

Update account information

branchCode
required
string

The customer id is a value assigned by the system identifying the customer.

accountNumber
required
string
accountStatusId
integer
accountStatus
required
string
customerId
integer
productId
integer <int64>

The product this account belongs to

accountName
required
any <string>

Account name

currencyCode
any <integer>

Base currency for the account

userId
integer

The user resposible for the entry, 0 for system or api

Responses

Request samples

Content type
{
  • "branchCode": 10001,
  • "accountNumber": "12345678901",
  • "accountStatusId": 0,
  • "accountStatus": "string",
  • "customerId": 10000,
  • "productId": 1,
  • "accountName": "A Person",
  • "currencyCode": 740,
  • "userId": 0
}

Response samples

Content type
{
  • "branchCode": 10001,
  • "accountNumber": "12345678901",
  • "accountStatusId": 0,
  • "accountStatus": "string",
  • "customerId": 10000,
  • "productId": 1,
  • "accountName": "A Person",
  • "currencyCode": 740,
  • "userId": 0
}

Deletes an account

Deletes an account

Request Body schema:

Deletes account information

branchCode
required
string

The customer id is a value assigned by the system identifying the customer.

accountNumber
required
string
accountStatusId
integer
accountStatus
required
string
customerId
integer
productId
integer <int64>

The product this account belongs to

accountName
required
any <string>

Account name

currencyCode
any <integer>

Base currency for the account

userId
integer

The user resposible for the entry, 0 for system or api

Responses

Request samples

Content type
{
  • "branchCode": 10001,
  • "accountNumber": "12345678901",
  • "accountStatusId": 0,
  • "accountStatus": "string",
  • "customerId": 10000,
  • "productId": 1,
  • "accountName": "A Person",
  • "currencyCode": 740,
  • "userId": 0
}

Response samples

Content type
{
  • "branchCode": 10001,
  • "accountNumber": "12345678901",
  • "accountStatusId": 0,
  • "accountStatus": "string",
  • "customerId": 10000,
  • "productId": 1,
  • "accountName": "A Person",
  • "currencyCode": 740,
  • "userId": 0
}

Find an account

Find an account

Request Body schema:

Find account information

branchCode
required
string

The customer id is a value assigned by the system identifying the customer.

accountNumber
required
string
accountStatusId
integer
accountStatus
required
string
customerId
integer
productId
integer <int64>

The product this account belongs to

accountName
required
any <string>

Account name

currencyCode
any <integer>

Base currency for the account

userId
integer

The user resposible for the entry, 0 for system or api

Responses

Request samples

Content type
{
  • "branchCode": 10001,
  • "accountNumber": "12345678901",
  • "accountStatusId": 0,
  • "accountStatus": "string",
  • "customerId": 10000,
  • "productId": 1,
  • "accountName": "A Person",
  • "currencyCode": 740,
  • "userId": 0
}

Response samples

Content type
{
  • "branchCode": 10001,
  • "accountNumber": "12345678901",
  • "accountStatusId": 0,
  • "accountStatus": "string",
  • "customerId": 10000,
  • "productId": 1,
  • "accountName": "A Person",
  • "currencyCode": 740,
  • "userId": 0
}

Get account statement

Get client information

Authorizations:
api_key
path Parameters
branchCode
required
string

Branch code of account

accountNumber
required
string
fromDate
required
string <date-time>
toDate
required
string <date-time>

Numeric ID of the client to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string

Responses

Response samples

Content type
application/json
{
  • "currentBalance": 0,
  • "availableBalance": 0,
  • "openingBalance": 0,
  • "transactions": [
    ]
}

transactions

Get account statement

Get client information

Authorizations:
api_key
path Parameters
branchCode
required
string

Branch code of account

accountNumber
required
string
fromDate
required
string <date-time>
toDate
required
string <date-time>

Numeric ID of the client to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string

Responses

Response samples

Content type
application/json
{
  • "currentBalance": 0,
  • "availableBalance": 0,
  • "openingBalance": 0,
  • "transactions": [
    ]
}

Adds a new client

Adds a new client

Authorizations:
api_key
header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string
Request Body schema: application/json

Adds a new client

branchCode
required
string

Branch code for the transaction

accountNumber
required
string
transactionId
required
string

A unique id identifying the transaction

transactionSequence
required
integer
transactionTimestamp
required
string

The date and time of the transaction

description
required
string

Description of the transaction

transactionAmount
required
number
transactionFee
required
number
transactionTax
required
number
channel
string
channelDetail
required
string
transactionType
required
string
transactionStatus
required
string

Responses

Request samples

Content type
application/json
{
  • "branchCode": 1001,
  • "accountNumber": "12345678901",
  • "transactionId": "d255dv-123",
  • "transactionSequence": 1,
  • "transactionTimestamp": "string",
  • "description": "string",
  • "transactionAmount": 0,
  • "transactionFee": 0,
  • "transactionTax": 0,
  • "channel": "string",
  • "channelDetail": "string",
  • "transactionType": "string",
  • "transactionStatus": "string"
}

Response samples

Content type
application/json
{
  • "branchCode": 1001,
  • "accountNumber": "12345678901",
  • "transactionId": "d255dv-123",
  • "transactionSequence": 1,
  • "transactionTimestamp": "string",
  • "description": "string",
  • "transactionAmount": 0,
  • "transactionFee": 0,
  • "transactionTax": 0,
  • "channel": "string",
  • "channelDetail": "string",
  • "transactionType": "string",
  • "transactionStatus": "string"
}

Updates client

Updates a client

Authorizations:
api_key
header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string
Request Body schema: application/json

Updates a client

client_id
integer
client_name
required
string
client_type
integer <int64>
Enum: 1 2

The type of client * 01 System Administrator * 02 Client

Responses

Request samples

Content type
application/json
{
  • "client_id": 10001,
  • "client_name": "A Client",
  • "client_type": 1
}

Response samples

Content type
application/json
{
  • "client_id": 10001
}

Get account transaction statement

Get client transaction statement

Authorizations:
api_key
path Parameters
customerId
required
integer

Numeric ID of the client to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string

Responses

Response samples

Content type
application/json
{
  • "client_id": 10001
}

reports

Get account statement

Get client information

Authorizations:
api_key
path Parameters
branchCode
required
string

Branch code of account

accountNumber
required
string
fromDate
required
string <date-time>
toDate
required
string <date-time>

Numeric ID of the client to get

header Parameters
X-Request-Timestamp
required
string <date-time>
X-Request-Hash
required
string
X-Request-ID
required
string
X-Request-Flags
required
string

Responses

Response samples

Content type
application/json
{
  • "currentBalance": 0,
  • "availableBalance": 0,
  • "openingBalance": 0,
  • "transactions": [
    ]
}