Back to Index

POST v1/BankAccounts

Creates a bank account

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

The Bank Account Request containing the information for the new account

bank_account_request
NameDescriptionTypeAdditional information
bank_account

The bank account which is to be created

bank_account

Required

verify_account_by_deposit

Set True if you would like to initiate the verification process by issuing a deposit to this Bank Account.

boolean

None.

document

Data that can be used to verify the account or conditions associated with the account. Typically a void cheque, PAD agreement or other official bank document.

document

None.

references

A list of fields used to pass additional information to record with the transfer request.

Collection of reference

None.

application_name

The name of the calling application

string

Required

String length: inclusive between 0 and 128

language_code

Determines the Language of the response data. 2 Character ISO LanguageCode. Supported language codes are: 'en' (English), 'fr' (French). Default is 'en'.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "bank_account": {
    "bank_account_token": "sample string 1",
    "name": "sample string 2",
    "owner": "sample string 3",
    "type_code": 4,
    "financial_institution_number": "sample string 5",
    "branch_transit_number": "sample string 6",
    "account_number": "sample string 7",
    "currency_code": "sample string 8"
  },
  "verify_account_by_deposit": true,
  "document": {
    "data": "sample string 1",
    "filename": "sample string 2",
    "media_type": "sample string 3"
  },
  "references": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "application_name": "sample string 2",
  "language_code": "en"
}

Response Information

Resource Description

A response indicating success or failure and a bank_account_token

bank_account_response
NameDescriptionTypeAdditional information
bank_account_token

The bank_account_token assigned to the newly created bank account

string

None.

success

True if successful, false otherwise

boolean

None.

message

The message related to the operation in the language specified by the request

string

None.

message_code

The code associated with the message

integer

None.

errors

List of validation errors that occured, otherwise empty

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "bank_account_token": "sample string 1",
  "success": true,
  "message": "sample string 3",
  "message_code": 4,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}