African BankAPI REST Documentation

accountId

String

false

Unique id of the account.

Must have at most 16 integral digits and 0 fractional digits.

id

String

true

Unique id of the account.

number

String

true

Account number of the queried account.

agentId

Integer

true

Id of logged in agent querying the accounts.

bankId

String

true

Bank Identity number.

branchCode

String

true

Branch code.

accountType

String

true

Account type.

customers

Array[Object]

true

Customers of the account.

customers[].customerId

String

true

Id of the customer holding the account.

customers[].displayName

String

true

Descriptive name of the account customer holding the account.

customers[].provider

String

true

Institution or bank providing the account services.

label

String

true

Label of the account.

type

String

true

The type of account.

balance

Object

true

Composition of the current balance in the account.

balance.currency

String

true

The currency of the current balance in the account.

balance.amount

Decimal

true

The amount of the current balance in the account.

swiftBic

String

true

Global account Swift BIC number.

openedDate

String

true

Date account was created.

closedDate

String

true

Date account was closed.

customerId

String

true

When present returns accounts for given customerId.

Must have at most 19 integral digits and 0 fractional digits.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

accounts

Array[Object]

true

An array of accounts.

accounts[].id

String

true

Unique id of the account.

accounts[].number

String

true

Account number of the queried account.

accounts[].agentId

Integer

true

Id of logged in agent querying the accounts.

accounts[].bankId

String

true

Bank Identity number.

accounts[].branchCode

String

true

Branch code.

accounts[].accountType

String

true

Account type.

accounts[].customers

Array[Object]

true

Customers of the account.

accounts[].customers[].customerId

String

true

Id of the customer holding the account.

accounts[].customers[].displayName

String

true

Descriptive name of the account customer holding the account.

accounts[].customers[].provider

String

true

Institution or bank providing the account services.

accounts[].label

String

true

Label of the account.

accounts[].type

String

true

The type of account.

accounts[].balance

Object

true

Composition of the current balance in the account.

accounts[].balance.currency

String

true

The currency of the current balance in the account.

accounts[].balance.amount

Decimal

true

The amount of the current balance in the account.

accounts[].swiftBic

String

true

Global account Swift BIC number.

accounts[].openedDate

String

true

Date account was created.

accounts[].closedDate

String

true

Date account was closed.

customerId

String

false

The ID of the customer for which you want to create another account for.

Must have at most 19 integral digits and 0 fractional digits.

productCode

String

true

A call account will be created by default when the product is not specified.

Size must be between 1 and 256 inclusive.

id

String

true

Unique id of the account.

number

String

true

Account number of the queried account.

agentId

Integer

true

Id of logged in agent querying the accounts.

bankId

String

true

Bank Identity number.

branchCode

String

true

Branch code.

accountType

String

true

Account type.

customers

Array[Object]

true

Customers of the account.

customers[].customerId

String

true

Id of the customer holding the account.

customers[].displayName

String

true

Descriptive name of the account customer holding the account.

customers[].provider

String

true

Institution or bank providing the account services.

label

String

true

Label of the account.

type

String

true

The type of account.

balance

Object

true

Composition of the current balance in the account.

balance.currency

String

true

The currency of the current balance in the account.

balance.amount

Decimal

true

The amount of the current balance in the account.

swiftBic

String

true

Global account Swift BIC number.

openedDate

String

true

Date account was created.

closedDate

String

true

Date account was closed.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

banks

Array[Object]

false

An array of local banks available for transacting with.

banks[].id

String

false

Bank unique member number.

Size must be between 1 and 10 inclusive.

banks[].shortName

String

false

The bank member short name.

Size must be between 1 and 30 inclusive.

banks[].fullName

String

false

The bank member full name.

banks[].defaultBranchCode

String

false

Bank default branch code.

Size must be between 1 and 6 inclusive.

banks[].swiftBic

String

false

Bank BIC code.

Size must be between 1 and 255 inclusive.

banks[].defaultBranchName

String

false

Bank default branch name.

Size must be between 1 and 255 inclusive.

banks[].foreign

Boolean

true

Indicates if bank is local bank in South Africa or Foreign.

customerId

String

false

Must have at most 19 integral digits and 0 fractional digits.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

beneficiaries

Array[Object]

false

A list of beneficiaries available for the user to transact with.

beneficiaries[].beneficiaryId

String

false

Beneficiary unique id.

beneficiaries[].name

String

false

Beneficiary name.

beneficiaries[].bankCode

String

false

Bank unique member number.

Size must be between 1 and 10 inclusive.

beneficiaries[].bankName

String

false

Bank name.

Size must be between 1 and 30 inclusive.

beneficiaries[].branchCode

String

false

Branch code.

Size must be between 1 and 6 inclusive.

beneficiaries[].branchName

String

false

Name of the branch.

beneficiaries[].accountType

String

false

Account type description.

beneficiaries[].accountNumber

String

false

Account number.

beneficiaries[].beneficiaryReference

String

false

Reference that must appear on beneficiary’s transaction.

Size must be between 1 and 30 inclusive.

beneficiaries[].clientReference

String

false

Reference that must appear on client’s transaction.

Size must be between 1 and 30 inclusive.

beneficiaries[].accountCategory

String

true

Account category description.

customerId

String

false

Must have at most 19 integral digits and 0 fractional digits.

beneficiaryId

String

false

The requested beneficiary id.

Must have at most 19 integral digits and 0 fractional digits.

beneficiaryId

String

false

Beneficiary unique id.

name

String

false

Beneficiary name.

bankCode

String

false

Bank unique member number.

Size must be between 1 and 10 inclusive.

bankName

String

false

Bank name.

Size must be between 1 and 30 inclusive.

branchCode

String

false

Branch code.

Size must be between 1 and 6 inclusive.

branchName

String

false

Name of the branch.

accountType

String

false

Account type description.

accountNumber

String

false

Account number.

beneficiaryReference

String

false

Reference that must appear on beneficiary’s transaction.

Size must be between 1 and 30 inclusive.

clientReference

String

false

Reference that must appear on client’s transaction.

Size must be between 1 and 30 inclusive.

accountCategory

String

true

Account category description.

customerId

String

false

Must have at most 19 integral digits and 0 fractional digits.

name

String

false

The name of the beneficiary.
Valid input is uppercase Latin letters, numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

bankCode

String

false

Bank unique member number.

Size must be between 1 and 10 inclusive.

branchCode

String

true

Branch code.

Size must be between 1 and 6 inclusive.

accountType

String

false

Valid account types are:
C: CURRENT
S: SAVINGS
T: TRANSMISSION
B: BOND ACCOUNT.

Size must be between 1 and 1 inclusive.

accountNumber

String

false

Account number.

Must match the regular expression [0-9]+.
Size must be between 1 and 16 inclusive.

beneficiaryReference

String

false

Reference that must appear on beneficiary’s transaction.
Valid input is uppercase Latin letters, numbers, space and punctuation.

Size must be between 1 and 30 inclusive.

clientReference

String

false

Reference that must appear on client’s transaction.
Valid input is uppercase Latin letters, numbers, space and punctuation.

Size must be between 1 and 30 inclusive.

accountCategory

String

false

Valid account categories are:
3RD PARTY
MANDATED.

Size must be between 1 and 10 inclusive.

beneficiaryId

String

false

Beneficiary unique id.

name

String

false

Beneficiary name.

bankCode

String

false

Bank unique member number.

Size must be between 1 and 10 inclusive.

bankName

String

false

Bank name.

Size must be between 1 and 30 inclusive.

branchCode

String

false

Branch code.

Size must be between 1 and 6 inclusive.

branchName

String

false

Name of the branch.

accountType

String

false

Account type description.

accountNumber

String

false

Account number.

beneficiaryReference

String

false

Reference that must appear on beneficiary’s transaction.

Size must be between 1 and 30 inclusive.

clientReference

String

false

Reference that must appear on client’s transaction.

Size must be between 1 and 30 inclusive.

accountCategory

String

true

Account category description.

customerReference

String

true

Customers unique reference number. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

agentReference

String

true

Agent reference number. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

adminFeePercent

String

true

Administration fee percentage.

Must have at most 2 integral digits and 2 fractional digits.

createCallAccount

Boolean

true

Deprecated.

Indicator to create call account.

defaultCustomer

Object

false

defaultCustomer.entityTypeId

String

false

Entity type id.

Valid Entity Type Ids are: 1 = Individual, 3 = Trust, 4 = CC, 5 = Pty (Ltd), 6 = Ltd.

Must be at least 1.
Must have at most 2 integral digits and 0 fractional digits.

defaultCustomer.name1

String

false

Name1 of the customer. If individual then surname else companies name. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Must contain alphabets.
Size must be between 1 and 255 inclusive.

defaultCustomer.name2

String

true

Name2 of the customer. Mandatory if entity type individual(1) and must be the individual’s name(s). Optional for all other entity types. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 0 and 255 inclusive.

defaultCustomer.mobilePhoneNumber

String

true

Customer mobile contact number.

Must have at most 14 integral digits and 0 fractional digits.

defaultCustomer.email

String

true

Customer email address. Valid input is Uppercase Latin letters , numbers and punctuation.

Must be a well-formed email address.

defaultCustomer.kycStatus

Boolean

true

Status of customer being KYC’d.

defaultCustomer.identifyingNumber

String

false

Identification Number.

Format specific to entity type:
1 = Individual, must be a valid SA ID number YYMMDDNNNNNNN.
3 = Trust, format not applicable
4 = CC, 5 = Pty (Ltd) or 6 = Ltd, must be YYYY/NNNNNN/NN.
YYYY, year must be greater or equal to 1800.
NN can be any one of:
06 = Public company Ltd,
07 = Private company (Pty) Lty,
08 = Non-profit company,
09 = Limited By Guarantee,
10 = External company,
12 = Non Profit External Company
21 = Personal liability company (Inc),
22 = Unlimited,
23 = Close Corporation (CC),
24 = Primary Co-Operative,
25 = Secondary Co-Operative,
26 = Tertiary Co-Operative
30 = State-owned company
31 = Statutory Body.

Size must be between 1 and 255 inclusive.

defaultCustomer.taxNumber

String

false

Tax number.

Size must be between 1 and 255 inclusive.

defaultCustomer.address

String

true

Customer address. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

defaultCustomer.investmentTypeId

Integer

true

Investment Type Id number. Defaults to ITF when not specified.

otherCustomers

Array[Object]

true

List of all the clients to be created for the account or matter. The default customer should NOT be included in this list.

otherCustomers[].entityTypeId

String

false

Entity type id.

Valid Entity Type Ids are: 1 = Individual, 3 = Trust, 4 = CC, 5 = Pty (Ltd), 6 = Ltd.

Must be at least 1.
Must have at most 2 integral digits and 0 fractional digits.

otherCustomers[].name1

String

false

Name1 of the customer. If individual then surname else companies name. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Must contain alphabets.
Size must be between 1 and 255 inclusive.

otherCustomers[].name2

String

true

Name2 of the customer. Mandatory if entity type individual(1) and must be the individual’s name(s). Optional for all other entity types. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 0 and 255 inclusive.

otherCustomers[].mobilePhoneNumber

String

true

Customer mobile contact number.

Must have at most 14 integral digits and 0 fractional digits.

otherCustomers[].email

String

true

Customer email address. Valid input is Uppercase Latin letters , numbers and punctuation.

Must be a well-formed email address.

otherCustomers[].kycStatus

Boolean

true

Status of customer being KYC’d.

otherCustomers[].identifyingNumber

String

false

Identification Number.

Format specific to entity type:
1 = Individual, must be a valid SA ID number YYMMDDNNNNNNN.
3 = Trust, format not applicable
4 = CC, 5 = Pty (Ltd) or 6 = Ltd, must be YYYY/NNNNNN/NN.
YYYY, year must be greater or equal to 1800.
NN can be any one of:
06 = Public company Ltd,
07 = Private company (Pty) Lty,
08 = Non-profit company,
09 = Limited By Guarantee,
10 = External company,
12 = Non Profit External Company
21 = Personal liability company (Inc),
22 = Unlimited,
23 = Close Corporation (CC),
24 = Primary Co-Operative,
25 = Secondary Co-Operative,
26 = Tertiary Co-Operative
30 = State-owned company
31 = Statutory Body.

Size must be between 1 and 255 inclusive.

otherCustomers[].taxNumber

String

false

Tax number.

Size must be between 1 and 255 inclusive.

otherCustomers[].address

String

true

Customer address. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

otherCustomers[].investmentTypeId

Integer

true

Investment Type Id number. Defaults to ITF when not specified.

customerId

String

false

Customer unique id.

defaultAccountNumber

String

true

The default account number for this account.

customerReference

String

true

Customers unique reference number.

Size must be between 1 and 255 inclusive.

agentReference

String

true

Agent reference number.

Size must be between 1 and 255 inclusive.

adminFeePercent

String

true

Administration fee percentage.

defaultCustomer

Object

true

Details of the main client of this account.

defaultCustomer.entityTypeId

String

false

Entity type id.

Valid Entity Type Ids are: 1 = Individual, 3 = Trust, 4 = CC, 5 = Pty (Ltd), 6 = Ltd.

Must be at least 1.
Must have at most 2 integral digits and 0 fractional digits.

defaultCustomer.name1

String

false

Name1 of the customer. If individual then surname else companies name. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Must contain alphabets.
Size must be between 1 and 255 inclusive.

defaultCustomer.name2

String

true

Name2 of the customer. Mandatory if entity type individual(1) and must be the individual’s name(s). Optional for all other entity types. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 0 and 255 inclusive.

defaultCustomer.mobilePhoneNumber

String

true

Customer mobile contact number.

Must have at most 14 integral digits and 0 fractional digits.

defaultCustomer.email

String

true

Customer email address. Valid input is Uppercase Latin letters , numbers and punctuation.

Must be a well-formed email address.

defaultCustomer.kycStatus

Boolean

true

Status of customer being KYC’d.

defaultCustomer.identifyingNumber

String

false

Identification Number.

Format specific to entity type:
1 = Individual, must be a valid SA ID number YYMMDDNNNNNNN.
3 = Trust, format not applicable
4 = CC, 5 = Pty (Ltd) or 6 = Ltd, must be YYYY/NNNNNN/NN.
YYYY, year must be greater or equal to 1800.
NN can be any one of:
06 = Public company Ltd,
07 = Private company (Pty) Lty,
08 = Non-profit company,
09 = Limited By Guarantee,
10 = External company,
12 = Non Profit External Company
21 = Personal liability company (Inc),
22 = Unlimited,
23 = Close Corporation (CC),
24 = Primary Co-Operative,
25 = Secondary Co-Operative,
26 = Tertiary Co-Operative
30 = State-owned company
31 = Statutory Body.

Size must be between 1 and 255 inclusive.

defaultCustomer.taxNumber

String

false

Tax number.

Size must be between 1 and 255 inclusive.

defaultCustomer.address

String

true

Customer address. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

defaultCustomer.investmentTypeId

Integer

true

Investment Type Id number. Defaults to ITF when not specified.

otherCustomers

Array[Object]

true

List of all other clients connected to this account.

otherCustomers[].entityTypeId

String

false

Entity type id.

Valid Entity Type Ids are: 1 = Individual, 3 = Trust, 4 = CC, 5 = Pty (Ltd), 6 = Ltd.

Must be at least 1.
Must have at most 2 integral digits and 0 fractional digits.

otherCustomers[].name1

String

false

Name1 of the customer. If individual then surname else companies name. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Must contain alphabets.
Size must be between 1 and 255 inclusive.

otherCustomers[].name2

String

true

Name2 of the customer. Mandatory if entity type individual(1) and must be the individual’s name(s). Optional for all other entity types. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 0 and 255 inclusive.

otherCustomers[].mobilePhoneNumber

String

true

Customer mobile contact number.

Must have at most 14 integral digits and 0 fractional digits.

otherCustomers[].email

String

true

Customer email address. Valid input is Uppercase Latin letters , numbers and punctuation.

Must be a well-formed email address.

otherCustomers[].kycStatus

Boolean

true

Status of customer being KYC’d.

otherCustomers[].identifyingNumber

String

false

Identification Number.

Format specific to entity type:
1 = Individual, must be a valid SA ID number YYMMDDNNNNNNN.
3 = Trust, format not applicable
4 = CC, 5 = Pty (Ltd) or 6 = Ltd, must be YYYY/NNNNNN/NN.
YYYY, year must be greater or equal to 1800.
NN can be any one of:
06 = Public company Ltd,
07 = Private company (Pty) Lty,
08 = Non-profit company,
09 = Limited By Guarantee,
10 = External company,
12 = Non Profit External Company
21 = Personal liability company (Inc),
22 = Unlimited,
23 = Close Corporation (CC),
24 = Primary Co-Operative,
25 = Secondary Co-Operative,
26 = Tertiary Co-Operative
30 = State-owned company
31 = Statutory Body.

Size must be between 1 and 255 inclusive.

otherCustomers[].taxNumber

String

false

Tax number.

Size must be between 1 and 255 inclusive.

otherCustomers[].address

String

true

Customer address. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

otherCustomers[].investmentTypeId

Integer

true

Investment Type Id number. Defaults to ITF when not specified.

customerId

String

false

The unique id of the customer to get details for.

Must have at most 19 integral digits and 0 fractional digits.

customerId

String

false

Customer unique id.

defaultAccountNumber

String

true

The default account number for this account.

customerReference

String

true

Customers unique reference number.

Size must be between 1 and 255 inclusive.

agentReference

String

true

Agent reference number.

Size must be between 1 and 255 inclusive.

adminFeePercent

String

true

Administration fee percentage.

defaultCustomer

Object

true

Details of the main client of this account.

defaultCustomer.entityTypeId

String

false

Entity type id.

Valid Entity Type Ids are: 1 = Individual, 3 = Trust, 4 = CC, 5 = Pty (Ltd), 6 = Ltd.

Must be at least 1.
Must have at most 2 integral digits and 0 fractional digits.

defaultCustomer.name1

String

false

Name1 of the customer. If individual then surname else companies name. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Must contain alphabets.
Size must be between 1 and 255 inclusive.

defaultCustomer.name2

String

true

Name2 of the customer. Mandatory if entity type individual(1) and must be the individual’s name(s). Optional for all other entity types. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 0 and 255 inclusive.

defaultCustomer.mobilePhoneNumber

String

true

Customer mobile contact number.

Must have at most 14 integral digits and 0 fractional digits.

defaultCustomer.email

String

true

Customer email address. Valid input is Uppercase Latin letters , numbers and punctuation.

Must be a well-formed email address.

defaultCustomer.kycStatus

Boolean

true

Status of customer being KYC’d.

defaultCustomer.identifyingNumber

String

false

Identification Number.

Format specific to entity type:
1 = Individual, must be a valid SA ID number YYMMDDNNNNNNN.
3 = Trust, format not applicable
4 = CC, 5 = Pty (Ltd) or 6 = Ltd, must be YYYY/NNNNNN/NN.
YYYY, year must be greater or equal to 1800.
NN can be any one of:
06 = Public company Ltd,
07 = Private company (Pty) Lty,
08 = Non-profit company,
09 = Limited By Guarantee,
10 = External company,
12 = Non Profit External Company
21 = Personal liability company (Inc),
22 = Unlimited,
23 = Close Corporation (CC),
24 = Primary Co-Operative,
25 = Secondary Co-Operative,
26 = Tertiary Co-Operative
30 = State-owned company
31 = Statutory Body.

Size must be between 1 and 255 inclusive.

defaultCustomer.taxNumber

String

false

Tax number.

Size must be between 1 and 255 inclusive.

defaultCustomer.address

String

true

Customer address. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

defaultCustomer.investmentTypeId

Integer

true

Investment Type Id number. Defaults to ITF when not specified.

otherCustomers

Array[Object]

true

List of all other clients connected to this account.

otherCustomers[].entityTypeId

String

false

Entity type id.

Valid Entity Type Ids are: 1 = Individual, 3 = Trust, 4 = CC, 5 = Pty (Ltd), 6 = Ltd.

Must be at least 1.
Must have at most 2 integral digits and 0 fractional digits.

otherCustomers[].name1

String

false

Name1 of the customer. If individual then surname else companies name. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Must contain alphabets.
Size must be between 1 and 255 inclusive.

otherCustomers[].name2

String

true

Name2 of the customer. Mandatory if entity type individual(1) and must be the individual’s name(s). Optional for all other entity types. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 0 and 255 inclusive.

otherCustomers[].mobilePhoneNumber

String

true

Customer mobile contact number.

Must have at most 14 integral digits and 0 fractional digits.

otherCustomers[].email

String

true

Customer email address. Valid input is Uppercase Latin letters , numbers and punctuation.

Must be a well-formed email address.

otherCustomers[].kycStatus

Boolean

true

Status of customer being KYC’d.

otherCustomers[].identifyingNumber

String

false

Identification Number.

Format specific to entity type:
1 = Individual, must be a valid SA ID number YYMMDDNNNNNNN.
3 = Trust, format not applicable
4 = CC, 5 = Pty (Ltd) or 6 = Ltd, must be YYYY/NNNNNN/NN.
YYYY, year must be greater or equal to 1800.
NN can be any one of:
06 = Public company Ltd,
07 = Private company (Pty) Lty,
08 = Non-profit company,
09 = Limited By Guarantee,
10 = External company,
12 = Non Profit External Company
21 = Personal liability company (Inc),
22 = Unlimited,
23 = Close Corporation (CC),
24 = Primary Co-Operative,
25 = Secondary Co-Operative,
26 = Tertiary Co-Operative
30 = State-owned company
31 = Statutory Body.

Size must be between 1 and 255 inclusive.

otherCustomers[].taxNumber

String

false

Tax number.

Size must be between 1 and 255 inclusive.

otherCustomers[].address

String

true

Customer address. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

otherCustomers[].investmentTypeId

Integer

true

Investment Type Id number. Defaults to ITF when not specified.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

customers

Array[Object]

true

An array of customers.

customers[].customerId

String

false

Customer unique id.

customers[].defaultAccountNumber

String

true

The default account number for this account.

customers[].customerReference

String

true

Customers unique reference number.

Size must be between 1 and 255 inclusive.

customers[].agentReference

String

true

Agent reference number.

Size must be between 1 and 255 inclusive.

customers[].adminFeePercent

String

true

Administration fee percentage.

customers[].defaultCustomer

Object

true

Details of the main client of this account.

customers[].defaultCustomer.entityTypeId

String

false

Entity type id.

Valid Entity Type Ids are: 1 = Individual, 3 = Trust, 4 = CC, 5 = Pty (Ltd), 6 = Ltd.

Must be at least 1.
Must have at most 2 integral digits and 0 fractional digits.

customers[].defaultCustomer.name1

String

false

Name1 of the customer. If individual then surname else companies name. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Must contain alphabets.
Size must be between 1 and 255 inclusive.

customers[].defaultCustomer.name2

String

true

Name2 of the customer. Mandatory if entity type individual(1) and must be the individual’s name(s). Optional for all other entity types. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 0 and 255 inclusive.

customers[].defaultCustomer.mobilePhoneNumber

String

true

Customer mobile contact number.

Must have at most 14 integral digits and 0 fractional digits.

customers[].defaultCustomer.email

String

true

Customer email address. Valid input is Uppercase Latin letters , numbers and punctuation.

Must be a well-formed email address.

customers[].defaultCustomer.kycStatus

Boolean

true

Status of customer being KYC’d.

customers[].defaultCustomer.identifyingNumber

String

false

Identification Number.

Format specific to entity type:
1 = Individual, must be a valid SA ID number YYMMDDNNNNNNN.
3 = Trust, format not applicable
4 = CC, 5 = Pty (Ltd) or 6 = Ltd, must be YYYY/NNNNNN/NN.
YYYY, year must be greater or equal to 1800.
NN can be any one of:
06 = Public company Ltd,
07 = Private company (Pty) Lty,
08 = Non-profit company,
09 = Limited By Guarantee,
10 = External company,
12 = Non Profit External Company
21 = Personal liability company (Inc),
22 = Unlimited,
23 = Close Corporation (CC),
24 = Primary Co-Operative,
25 = Secondary Co-Operative,
26 = Tertiary Co-Operative
30 = State-owned company
31 = Statutory Body.

Size must be between 1 and 255 inclusive.

customers[].defaultCustomer.taxNumber

String

false

Tax number.

Size must be between 1 and 255 inclusive.

customers[].defaultCustomer.address

String

true

Customer address. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

customers[].defaultCustomer.investmentTypeId

Integer

true

Investment Type Id number. Defaults to ITF when not specified.

customers[].otherCustomers

Array[Object]

true

List of all other clients connected to this account.

customers[].otherCustomers[].entityTypeId

String

false

Entity type id.

Valid Entity Type Ids are: 1 = Individual, 3 = Trust, 4 = CC, 5 = Pty (Ltd), 6 = Ltd.

Must be at least 1.
Must have at most 2 integral digits and 0 fractional digits.

customers[].otherCustomers[].name1

String

false

Name1 of the customer. If individual then surname else companies name. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Must contain alphabets.
Size must be between 1 and 255 inclusive.

customers[].otherCustomers[].name2

String

true

Name2 of the customer. Mandatory if entity type individual(1) and must be the individual’s name(s). Optional for all other entity types. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 0 and 255 inclusive.

customers[].otherCustomers[].mobilePhoneNumber

String

true

Customer mobile contact number.

Must have at most 14 integral digits and 0 fractional digits.

customers[].otherCustomers[].email

String

true

Customer email address. Valid input is Uppercase Latin letters , numbers and punctuation.

Must be a well-formed email address.

customers[].otherCustomers[].kycStatus

Boolean

true

Status of customer being KYC’d.

customers[].otherCustomers[].identifyingNumber

String

false

Identification Number.

Format specific to entity type:
1 = Individual, must be a valid SA ID number YYMMDDNNNNNNN.
3 = Trust, format not applicable
4 = CC, 5 = Pty (Ltd) or 6 = Ltd, must be YYYY/NNNNNN/NN.
YYYY, year must be greater or equal to 1800.
NN can be any one of:
06 = Public company Ltd,
07 = Private company (Pty) Lty,
08 = Non-profit company,
09 = Limited By Guarantee,
10 = External company,
12 = Non Profit External Company
21 = Personal liability company (Inc),
22 = Unlimited,
23 = Close Corporation (CC),
24 = Primary Co-Operative,
25 = Secondary Co-Operative,
26 = Tertiary Co-Operative
30 = State-owned company
31 = Statutory Body.

Size must be between 1 and 255 inclusive.

customers[].otherCustomers[].taxNumber

String

false

Tax number.

Size must be between 1 and 255 inclusive.

customers[].otherCustomers[].address

String

true

Customer address. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

customers[].otherCustomers[].investmentTypeId

Integer

true

Investment Type Id number. Defaults to ITF when not specified.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

customers

Array[Object]

true

An array of customers.

customers[].customerId

String

false

Customer unique id.

customers[].defaultAccountNumber

String

true

The default account number for this account.

customers[].customerReference

String

true

Customers unique reference number.

Size must be between 1 and 255 inclusive.

customers[].agentReference

String

true

Agent reference number.

Size must be between 1 and 255 inclusive.

customers[].adminFeePercent

String

true

Administration fee percentage.

customers[].defaultCustomer

Object

true

Details of the main client of this account.

customers[].defaultCustomer.entityTypeId

String

false

Entity type id.

Valid Entity Type Ids are: 1 = Individual, 3 = Trust, 4 = CC, 5 = Pty (Ltd), 6 = Ltd.

Must be at least 1.
Must have at most 2 integral digits and 0 fractional digits.

customers[].defaultCustomer.name1

String

false

Name1 of the customer. If individual then surname else companies name. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Must contain alphabets.
Size must be between 1 and 255 inclusive.

customers[].defaultCustomer.name2

String

true

Name2 of the customer. Mandatory if entity type individual(1) and must be the individual’s name(s). Optional for all other entity types. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 0 and 255 inclusive.

customers[].defaultCustomer.mobilePhoneNumber

String

true

Customer mobile contact number.

Must have at most 14 integral digits and 0 fractional digits.

customers[].defaultCustomer.email

String

true

Customer email address. Valid input is Uppercase Latin letters , numbers and punctuation.

Must be a well-formed email address.

customers[].defaultCustomer.kycStatus

Boolean

true

Status of customer being KYC’d.

customers[].defaultCustomer.identifyingNumber

String

false

Identification Number.

Format specific to entity type:
1 = Individual, must be a valid SA ID number YYMMDDNNNNNNN.
3 = Trust, format not applicable
4 = CC, 5 = Pty (Ltd) or 6 = Ltd, must be YYYY/NNNNNN/NN.
YYYY, year must be greater or equal to 1800.
NN can be any one of:
06 = Public company Ltd,
07 = Private company (Pty) Lty,
08 = Non-profit company,
09 = Limited By Guarantee,
10 = External company,
12 = Non Profit External Company
21 = Personal liability company (Inc),
22 = Unlimited,
23 = Close Corporation (CC),
24 = Primary Co-Operative,
25 = Secondary Co-Operative,
26 = Tertiary Co-Operative
30 = State-owned company
31 = Statutory Body.

Size must be between 1 and 255 inclusive.

customers[].defaultCustomer.taxNumber

String

false

Tax number.

Size must be between 1 and 255 inclusive.

customers[].defaultCustomer.address

String

true

Customer address. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

customers[].defaultCustomer.investmentTypeId

Integer

true

Investment Type Id number. Defaults to ITF when not specified.

customers[].otherCustomers

Array[Object]

true

List of all other clients connected to this account.

customers[].otherCustomers[].entityTypeId

String

false

Entity type id.

Valid Entity Type Ids are: 1 = Individual, 3 = Trust, 4 = CC, 5 = Pty (Ltd), 6 = Ltd.

Must be at least 1.
Must have at most 2 integral digits and 0 fractional digits.

customers[].otherCustomers[].name1

String

false

Name1 of the customer. If individual then surname else companies name. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Must contain alphabets.
Size must be between 1 and 255 inclusive.

customers[].otherCustomers[].name2

String

true

Name2 of the customer. Mandatory if entity type individual(1) and must be the individual’s name(s). Optional for all other entity types. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 0 and 255 inclusive.

customers[].otherCustomers[].mobilePhoneNumber

String

true

Customer mobile contact number.

Must have at most 14 integral digits and 0 fractional digits.

customers[].otherCustomers[].email

String

true

Customer email address. Valid input is Uppercase Latin letters , numbers and punctuation.

Must be a well-formed email address.

customers[].otherCustomers[].kycStatus

Boolean

true

Status of customer being KYC’d.

customers[].otherCustomers[].identifyingNumber

String

false

Identification Number.

Format specific to entity type:
1 = Individual, must be a valid SA ID number YYMMDDNNNNNNN.
3 = Trust, format not applicable
4 = CC, 5 = Pty (Ltd) or 6 = Ltd, must be YYYY/NNNNNN/NN.
YYYY, year must be greater or equal to 1800.
NN can be any one of:
06 = Public company Ltd,
07 = Private company (Pty) Lty,
08 = Non-profit company,
09 = Limited By Guarantee,
10 = External company,
12 = Non Profit External Company
21 = Personal liability company (Inc),
22 = Unlimited,
23 = Close Corporation (CC),
24 = Primary Co-Operative,
25 = Secondary Co-Operative,
26 = Tertiary Co-Operative
30 = State-owned company
31 = Statutory Body.

Size must be between 1 and 255 inclusive.

customers[].otherCustomers[].taxNumber

String

false

Tax number.

Size must be between 1 and 255 inclusive.

customers[].otherCustomers[].address

String

true

Customer address. Valid input is Uppercase Latin letters , numbers, space and punctuation.

Size must be between 1 and 255 inclusive.

customers[].otherCustomers[].investmentTypeId

Integer

true

Investment Type Id number. Defaults to ITF when not specified.

customerId

String

false

Must have at most 19 integral digits and 0 fractional digits.

message

String

false

Size must be between 0 and 256 inclusive.

fromDepartment

String

false

Size must be between 0 and 100 inclusive.

fromPerson

String

false

Size must be between 0 and 100 inclusive.

message

String

false

Size must be between 0 and 256 inclusive.

fromDepartment

String

false

Size must be between 0 and 100 inclusive.

fromPerson

String

false

Size must be between 0 and 100 inclusive.

id

String

true

dateCreated

String

true

customerId

String

false

Must have at most 19 integral digits and 0 fractional digits.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

messages

Array[Object]

true

messages[].message

String

false

Size must be between 0 and 256 inclusive.

messages[].fromDepartment

String

false

Size must be between 0 and 100 inclusive.

messages[].fromPerson

String

false

Size must be between 0 and 100 inclusive.

messages[].id

String

true

messages[].dateCreated

String

true

guaranteeID

String

false

The guarantee ID used to query state.

Size must be between 1 and 255 inclusive.

state

String

true

State of the Guarantee either VALID or INVALID.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

investmentTypes

Array[Object]

false

investmentTypes[].id

Integer

false

Investment Type id.

investmentTypes[].description

String

false

Description of the Investment Type.

name

String

true

When present returns the public account for the given name.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

publicAccounts

Array[Object]

true

An array of public accounts.

publicAccounts[].accountId

String

true

ID of the public account.

publicAccounts[].name

String

true

Name of the public account.

code

String

false

The code used to identify the product specfic to the agent.

Size must be between 1 and 255 inclusive.

code

String

false

The unique code of the product offered by the bank.

description

String

false

The Description of the product.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

products

Array[Object]

false

A list of products available for use by a Grindrod bank client.

products[].code

String

false

The unique code of the product offered by the bank.

products[].description

String

false

The Description of the product.

userId

String

false

User to add entitlement to.

Size must be between 1 and 255 inclusive.

roleName

String

false

Role name.

Size must be between 1 and 255 inclusive.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

list

Array[Object]

true

list[].roleName

String

false

Role name.

Size must be between 1 and 255 inclusive.

list[].id

String

true

Entitlement id.

userId

String

false

User to remove entitlement from.

Size must be between 1 and 255 inclusive.

entitlementId

String

false

Entitlement to remove.

Size must be between 1 and 255 inclusive.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

list

Array[Object]

true

list[].roleName

String

false

Role name.

Size must be between 1 and 255 inclusive.

list[].id

String

true

Entitlement id.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

list

Array[Object]

true

list[].roleName

String

false

Role name.

Size must be between 1 and 255 inclusive.

list[].id

String

true

Entitlement id.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

list

Array[Object]

true

list[].roleName

String

false

Role name.

Size must be between 1 and 255 inclusive.

list[].id

String

true

Entitlement id.

userId

String

false

User to get entitlements for.

Size must be between 1 and 255 inclusive.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

list

Array[Object]

true

list[].roleName

String

false

Role name.

Size must be between 1 and 255 inclusive.

list[].id

String

true

Entitlement id.

accountId

String

false

Unique id of the account.

Must have at most 16 integral digits and 0 fractional digits.

customerId

String

false

Id of the customer holding the account.

Must have at most 19 integral digits and 0 fractional digits.

fromDate

Object

false

Transaction start date.

Must be a valid date in the format of yyyy-MM-dd.

toDate

Object

false

Last transaction date.

Must be a valid date in the format of yyyy-MM-dd.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

transactions

Array[Object]

true

An array of transactions for an account between the specified dates.

transactions[].id

String

true

Unique id of the transaction.

transactions[].thisAccount

Object

true

Account against which transaction was made.

transactions[].thisAccount.id

String

true

Unique id of the account.

transactions[].thisAccount.number

String

true

Account number of the queried account.

transactions[].thisAccount.agentId

Integer

true

Id of logged in agent querying the accounts.

transactions[].thisAccount.bankId

String

true

Bank id.

transactions[].thisAccount.branchCode

String

true

Branch code.

transactions[].thisAccount.accountType

String

true

Account type.

transactions[].thisAccount.customers

Array[Object]

true

Customers of the account.

transactions[].thisAccount.customers[].customerId

String

true

Id of the customer holding the account.

transactions[].thisAccount.customers[].displayName

String

true

Descriptive name of the account customer holding the account.

transactions[].thisAccount.customers[].provider

String

true

Institution or bank providing the account services.

transactions[].otherAccount

Object

true

Account to which transaction was made.

transactions[].otherAccount.id

String

true

Unique id of the account.

transactions[].otherAccount.number

String

true

Account number of the queried account.

transactions[].otherAccount.agentId

Integer

true

Id of logged in agent querying the accounts.

transactions[].otherAccount.bankId

String

true

Bank id.

transactions[].otherAccount.branchCode

String

true

Branch code.

transactions[].otherAccount.accountType

String

true

Account type.

transactions[].otherAccount.customers

Array[Object]

true

Customers of the account.

transactions[].otherAccount.customers[].customerId

String

true

Id of the customer holding the account.

transactions[].otherAccount.customers[].displayName

String

true

Descriptive name of the account customer holding the account.

transactions[].otherAccount.customers[].provider

String

true

Institution or bank providing the account services.

transactions[].details

Object

true

Details of the transaction.

transactions[].details.type

String

true

WITHDRAWAL, DEPOSIT or TRANSFER.

transactions[].details.description

String

true

Description of transaction which will appear on statements.

transactions[].details.fromReference

String

true

Customer fromReference for transaction.

transactions[].details.toReference

String

true

Customer toReference for transaction.

transactions[].details.systemReference

String

true

System generated reference for transaction.

transactions[].details.posted

String

true

Date transaction was posted.

transactions[].details.completed

String

true

Date transaction was completed.

transactions[].details.newBalance

Object

true

Balance of the account after transaction.

transactions[].details.newBalance.currency

String

true

Currency.

transactions[].details.newBalance.amount

Decimal

true

Amount.

transactions[].details.value

Object

true

Amount that this transaction is for.

transactions[].details.value.currency

String

true

Currency.

transactions[].details.value.amount

Decimal

true

Amount.

accountId

String

false

Unique id of the account.

Must have at most 16 integral digits and 0 fractional digits.

transactionId

String

false

The transaction id of a transaction.

Must have at most 16 integral digits and 0 fractional digits.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

transactions

Array[Object]

true

An array of transactions for an account between the specified dates.

transactions[].id

String

true

Unique id of the transaction.

transactions[].thisAccount

Object

true

Account against which transaction was made.

transactions[].thisAccount.id

String

true

Unique id of the account.

transactions[].thisAccount.number

String

true

Account number of the queried account.

transactions[].thisAccount.agentId

Integer

true

Id of logged in agent querying the accounts.

transactions[].thisAccount.bankId

String

true

Bank id.

transactions[].thisAccount.branchCode

String

true

Branch code.

transactions[].thisAccount.accountType

String

true

Account type.

transactions[].thisAccount.customers

Array[Object]

true

Customers of the account.

transactions[].thisAccount.customers[].customerId

String

true

Id of the customer holding the account.

transactions[].thisAccount.customers[].displayName

String

true

Descriptive name of the account customer holding the account.

transactions[].thisAccount.customers[].provider

String

true

Institution or bank providing the account services.

transactions[].otherAccount

Object

true

Account to which transaction was made.

transactions[].otherAccount.id

String

true

Unique id of the account.

transactions[].otherAccount.number

String

true

Account number of the queried account.

transactions[].otherAccount.agentId

Integer

true

Id of logged in agent querying the accounts.

transactions[].otherAccount.bankId

String

true

Bank id.

transactions[].otherAccount.branchCode

String

true

Branch code.

transactions[].otherAccount.accountType

String

true

Account type.

transactions[].otherAccount.customers

Array[Object]

true

Customers of the account.

transactions[].otherAccount.customers[].customerId

String

true

Id of the customer holding the account.

transactions[].otherAccount.customers[].displayName

String

true

Descriptive name of the account customer holding the account.

transactions[].otherAccount.customers[].provider

String

true

Institution or bank providing the account services.

transactions[].details

Object

true

Details of the transaction.

transactions[].details.type

String

true

WITHDRAWAL, DEPOSIT or TRANSFER.

transactions[].details.description

String

true

Description of transaction which will appear on statements.

transactions[].details.fromReference

String

true

Customer fromReference for transaction.

transactions[].details.toReference

String

true

Customer toReference for transaction.

transactions[].details.systemReference

String

true

System generated reference for transaction.

transactions[].details.posted

String

true

Date transaction was posted.

transactions[].details.completed

String

true

Date transaction was completed.

transactions[].details.newBalance

Object

true

Balance of the account after transaction.

transactions[].details.newBalance.currency

String

true

Currency.

transactions[].details.newBalance.amount

Decimal

true

Amount.

transactions[].details.value

Object

true

Amount that this transaction is for.

transactions[].details.value.currency

String

true

Currency.

transactions[].details.value.amount

Decimal

true

Amount.

accountId

String

false

Id of the account.

Must have at most 16 integral digits and 0 fractional digits.

page

Object

false

sortResponses

Array[Object]

true

sortResponses[].property

String

true

sortResponses[].direction

String

true

transactionRequestTypes

Array[Object]

true

List of Transaction Request Types.

transactionRequestTypes[].value

String

true

Transaction type code.