Go Library Reference

operationID

string

Unique ID generated to identify a specific operation.

success

Bool

Returns true if request is successful and false otherwise.

status

APIStatus
(Enum)

The status of the job.

done - Operation Completed.
failed - Operation Failed.
user_input_required - Pending User Input.
initialized - Operation In Progress.

userInputs

[]UserInput

Specifies the type of further information required from the user before the job can be completed.

Note: It's only returned if operation status is user_input_required

type

string

Type of error encountered.
Note: It's only returned if operation status is failed.

msg

string

Detailed description of the error.

Note: It's only returned if operation status is failed.

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

query

string

Textual description of what is required from the user side.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

string

User input that must be submitted. In the response it will always be empty.

accessCode REQUIRED

string

Unique code for a user’s successful login to Connect. Returned in the response of UserLogin.

connectionID
REQUIRED

string

The connectionIDz from a user’s successful log in to Connect`.

accessToken

string

A unique permanent token linked to the user.

accessToken REQUIRED

string

Access Token obtained using the exchangeToken method.

userSecret
REQUIRED

string

The userSecret from a user’s successful log in to Connect.

operationID
OPTIONAL

string

The operationID from a previous call's response.
Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs
OPTIONAL

[]UserInput

Array of UserInput object, that are needed to complete this operation.
Required only if a previous call responded with user_input_required status.

You can read more about user inputs specification onSpecify User Input

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

identity

Identity

An object containing the identity data of the user.

accessToken REQUIRED

string

Access Token obtained using the exchangeToken method.

userSecret
REQUIRED

string

The userSecret from a user’s successful log in to Connect.

operationID
REQUIRED

string

The operationID from a previous call's response.
Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs

[]UserInput

Array of UserInput object, that are needed to complete this operation.
Required only if a previous call responded with user_input_required status.

You can read more about user inputs specification on Specify User Input

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

accounts

Account[]

An array containing the accounts data of the user.

accountID REQUIRED

String

The bank account ID which its balance is requested.
Retrieved from one of the accounts returned from the getAccounts method.

accessToken
REQUIRED

String

Access Token obtained using the exchangeToken method.

userSecret
REQUIRED

String

The userSecret from a user’s successful log in to Connect.

operationID
OPTIONAL

String

The operationID from a previous call's response.
Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs
OPTIONAL

[]UserInput

Array of UserInput object, that are needed to complete this operation.
Required only if a previous call responded with user_input_required status.

You can read more about user inputs specification on Specify User Input

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

balance

Balance

An object containing the account's balance information.

accountID REQUIRED

String

The bank account ID which its transactions are requested.
Retrieved from one of the accounts returned from the getAccounts method.

fromDate
REQUIRED

LocalDate

The start date of the transactions wanted.

toDate
REQUIRED

LocalDate

The end date of the transactions wanted.

accessToken
REQUIRED

String

Access Token obtained using the exchangeToken method.

userSecret
REQUIRED

String

The userSecret from a user’s successful log in to Connect.

operationID
OPTIONAL

String

The operationID from a previous call's response.
Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs
OPTIONAL

UserInput[]

Array of UserInput object, that are needed to complete this operation.
Required only if a previous call responded with user_input_required status.

You can read more about user inputs specification on Specify User Input

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

transactions

Transaction[]

Array containing the transactional data for the specified account within the specified period.

accountID REQUIRED

String

The bank account ID which its transactions are requested.
Retrieved from one of the accounts returned from the getAccounts method.

fromDate
REQUIRED

LocalDate

The start date of the transactions wanted.

toDate
REQUIRED

LocalDate

The end date of the transactions wanted.

accessToken
REQUIRED

String

Access Token obtained using the exchangeToken method.

userSecret
REQUIRED

String

The userSecret from a user’s successful log in to Connect.

operationID
OPTIONAL

String

The operationID from a previous call's response.
Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs
OPTIONAL

UserInput[]

Array of UserInput object, that are needed to complete this operation.
Required only if a previous call responded with user_input_required status.

You can read more about user inputs specification on Specify User Input

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

transactions

CategorizedTransaction[]

Array containing the transactional data for the specified account within the specified period, plus category of each transaction.

accountID REQUIRED

String

The bank account ID which its transactions are requested.
Retrieved from one of the accounts returned from the getAccounts method.

fromDate
REQUIRED

LocalDate

The start date of the transactions wanted.

toDate
REQUIRED

LocalDate

The end date of the transactions wanted.

accessToken
REQUIRED

String

Access Token obtained using the exchangeToken method.

userSecret
REQUIRED

String

The userSecret from a user’s successful log in to Connect.

operationID
OPTIONAL

String

The operationID from a previous call's response.
Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs
OPTIONAL

UserInput[]

Array of UserInput object, that are needed to complete this operation.
Required only if a previous call responded with user_input_required status.

You can read more about user inputs specification on Specify User Input

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

transactions

EnrichedTransaction[]

Array containing the transactional data for the specified account within the specified period, plus brand details (logo, name) of each transaction.

accessToken REQUIRED

String

Access Token obtained using the exchangeToken method.

userSecret
REQUIRED

String

The userSecret from a user’s successful log in to Connect.

operationID
OPTIONAL

String

The operationID from a previous call's response.
Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs
OPTIONAL

[]UserInput

Array of UserInput object, that are needed to complete this operation.
Required only if a previous call responded with user_input_required status.

You can read more about user inputs specification on Specify User Input

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

beneficiaries

[]Beneficiary

An array containing the beneficiary information.

beneficiary REQUIRED

request.CreateBeneficiaryInfo

An object that contains info about the beneficiary that should be added.

accessToken
REQUIRED

String

Access Token obtained using the exchangeToken method.

userSecret
REQUIRED

String

The userSecret from a user’s successful log in to Connect.

operationID
OPTIONAL

String

The operationID from a previous call's response.
Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs
OPTIONAL

[]UserInput

Array of UserInput object, that are needed to complete this operation.
Required only if a previous call responded with user_input_required status.

You can read more about user inputs specification on Specify User Input

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

name REQUIRED

string

Name of the beneficiary.

nickname
REQUIRED

string

Nickname of the beneficiary.

accountNumber
REQUIRED

string

Account number of the beneficiary.

iban
REQUIRED

string

Beneficiary's IBAN number.

swiftCode
REQUIRED

string

Beneficiary's financial institution's SWIFT code.

type
REQUIRED

response.BeneficiaryType (Enum)

Type of beneficiary.
For further explanation see Beneficiary Types.

address
REQUIRED

response.BeneficiaryAddress

An object containing the address information of the beneficiary.

country
REQUIRED

string

Name of the country in all uppercase letters.

branchAddress
REQUIRED

string

Address of the financial institution’s specific branch.

branchName
REQUIRED

string

Name of the financial institution’s specific branch.

phoneNumber
OPTIONAL

string

Beneficiary's phone number.

routingNumber
OPTIONAL

string

Beneficiary's Routing number, needed only for US banks accounts.

line1 REQUIRED

string

Street name and number. Note: value should not contain any commas or special characters.

line2
REQUIRED

string

City name. Note: value should not contain any commas or special characters.

line3
REQUIRED

string

Country name. Note: value should not contain any commas or special characters.

transfer REQUIRED

CreateTransfer

An object that contains info about the transfer that should be initiated, and any other details that's used to automate the operation.

accessToken
REQUIRED

String

Access Token obtained using the exchangeToken method.

userSecret
REQUIRED

String

The userSecret from a user’s successful log in to Connect.

operationID
OPTIONAL

String

The operationID from a previous call's response.
Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs
OPTIONAL

[]UserInput

Array of UserInput object, that are needed to complete this operation.
Required only if a previous call responded with user_input_required status.

You can read more about user inputs specification on Specify User Input

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

senderID REQUIRED

String

The id of the account which the money should be sent from.
Retrieved from one of the accounts array returned from the getAccounts method.

amount
REQUIRED

float64

The amount of money which should be sent.

receiverID
OPTIONAL

String

The id of the beneficiary which the money should be sent to.
Retrieved from one of the beneficiaries array returned from the getBeneficiaries method.
Needed only when creating a transfer from a bank that requires the receiver to be already registered as a beneficiary to perform a transaction.

name
OPTIONAL

String

The name of receiver.
Needed only when creating a transfer from a bank that handles the creation of beneficiaries on its own, internally, and doesn't require the receiver to be already registered as a beneficiary to perform a transaction.

accountNumber
OPTIONAL

String

The Account Number of the receiver's account.
Needed only when creating a transfer from a bank that handles the creation of beneficiaries on its own, internally, and doesn't require the receiver to be already registered as a beneficiary to perform a transaction.

iban
OPTIONAL

String

The IBAN of the receiver's account.
Needed only when creating a transfer from a bank that handles the creation of beneficiaries on its own, internally, and doesn't require the receiver to be already registered as a beneficiary to perform a transaction.

reference

String

Transaction reference string returned by the bank.

transfer REQUIRED

TransferAutoflow

An object that contains info about the transfer that should be initiated, and any other details that's used to automate the operation.

accessToken
REQUIRED

String

Access Token obtained using the exchangeToken method.

userSecret
REQUIRED

String

The userSecret from a user’s successful log in to Connect.

operationID
OPTIONAL

String

The operationID from a previous call's response.
Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs
OPTIONAL

[]UserInput

Array of UserInput object, that are needed to complete this operation.
Required only if a previous call responded with user_input_required status.

You can read more about user inputs specification on Specify User Input

id

UserInputID
(Enum)

Type of input required.

You can read more about user input types on User Input Types.

index

int

Is used in case more than one user input is requested.
Will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

senderID REQUIRED

String

The id of the account which the money should be sent from.
Retrieved from one of the accounts array returned from the getAccounts method.

amount
REQUIRED

float64

The amount of money which should be sent.

beneficiary
REQUIRED

request.BeneficiaryInfo

An object that holds the info about the beneficiary which the money should be sent to.

bankID
REQUIRED

String

The bankID of the user which is initiating this transfer.

name REQUIRED

String

Name of the beneficiary.

nickname
REQUIRED

String

Nickname of the beneficiary.

accountNumber
REQUIRED

String

Account number of the beneficiary.

iban
REQUIRED

String

Beneficiary's IBAN number.

swiftCode
REQUIRED

String

Beneficiary's financial institution's SWIFT code.

address
REQUIRED

response.BeneficiaryAddress

An object containing the address information of the beneficiary.

country
REQUIRED

String

Name of the country in all uppercase letters.

branchAddress
REQUIRED

String

Address of the financial institution’s specific branch.

branchName
REQUIRED

String

Name of the financial institution’s specific branch.

phoneNumber
OPTIONAL

String

Beneficiary's phone number.

routingNumber
OPTIONAL

String

Beneficiary's Routing number, needed only for US banks accounts

line1 REQUIRED

String

Street name and number. Note: value should not contain any commas or special characters.

line2
REQUIRED

String

City name. Note: value should not contain any commas or special characters.

line3
REQUIRED

String

Country name. Note: value should not contain any commas or special characters.

reference

String

Transaction reference string returned by the bank.

accessToken REQUIRED

String

Access Token obtained using Exchange Token method.

You can read more about how to obtain a permanent token on Obtain an Access Token

userSecret
REQUIRED

String

User secret returned during the successful authentication in Connect Layer

transfer
REQUIRED

Object<Transfer>

Details of the ACH transfer

operationID
OPTIONAL

String

The operationID from a previous call's response. Required only when resuming a previous call that responded with user_input_required status, to provided user inputs.

userInputs
OPTIONAL

Array<userInputs>

Array of UserInputs object, required only if initial request responded with user inputs specification.

You can read more about user inputs specification on Specify User Input

senderId

String

senderId of the Account from where the amount must be transferred.

amount

Number

Amount of the transfer

description

String

A message associated with the transfer.

id

Enum

Type of input required. Can be one of the following:

otp

secret_question

captcha

pin

confirmation

token

You can read more about user input types on User Input Types

query

String

Textual description of what is required from the user side

index

Number

Is used in case more than one user input is requested.

will always be 0 If only one input is requested.

answer

String

User input that must be submitted. In the response it will always be empty.

accessToken REQUIRED

String

Access Token obtained using Exchange Token method.

You can read more about how to obtain a permanent token on Obtain an Access Token

userSecret
REQUIRED

String

User secret returned during the successful authentication in Connect Layer

operationID
REQUIRED

String

The operationID from a previous call's response. Used to locate the ACH transaction.

userInputs
OPTIONAL

Array<userInputs>

Array of UserInputs object, required only if initial request responded with user inputs specification.

You can read more about user inputs specification on Specify User Input

transfer

Object<Transfer>

Details of the ACH transfer

status

String

Status of the transfer (ENUM: 'pending', 'completed', 'returned', 'rejected')

amount

Number

Amount of the transfer

currency

Object<Currency>

Currency type of the transfer

Code

String

Currency code

Name

String

Full name of the Currency