Go Library Reference

BaseResponse

All the responses extend BaseResponse class. Meaning all the responses described below in the document will have following fields besides the ones specific to each response.

Parameter

Type

Description

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.

UserInput Object

Parameter

Type

Description

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.

Methods

Auth.ExchangeToken

Method is used to obtain user's permanent access token by exchanging it with access code received during the user authentication (user login).

📘

Note

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

Method Description

func (*Auth) ExchangeToken(accessCode string, connectionID string) (*response.ExchangeTokenResponse, error)

Input Parameters

Parameter

Type

Description

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`.

Response
In addition to the fields described in the BaseResponse, it has the following fields, which will only be returned if the status is done:

Parameter

Type

Description

accessToken

string

A unique permanent token linked to the user.

Data.GetIdentity

This method is used to retrieve personal details about the user.
Method Description

func (*Data) GetIdentity(accessToken string, userSecret string, userInputs []response.UserInput, operationID string) (*response.IdentityResponse, error)

Method Description

Parameter

Type

Description

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

UserInput Object

Parameter

Type

Description

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.

Response
In addition to the fields described in the BaseResponse, it has the following fields, which will only be returned if the status is done:

Parameter

Type

Description

identity

Identity

An object containing the identity data of the user.

Data.GetAccounts

Method is used to retrieve list of all the bank accounts registered on the user. The list will contain all types of bank accounts.

Method Description

func (*Data) GetAccounts(accessToken string, userSecret string, userInputs []response.UserInput, operationID string) (*response.AccountsResponse, error)

Input Parameters

Parameter

Type

Description

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

UserInput Object

Parameter

Type

Description

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.

Response
In addition to the fields described in the BaseResponse, it has the following fields, which will only be returned if the status is done:

Parameter

Type

Description

accounts

Account[]

An array containing the accounts data of the user.

Data.GetBalance

This method is used to retrieve balance on specific bank account of the user.

Method Description

func (*Data) GetBalance(accessToken string, userSecret string, accountID string, userInputs []response.UserInput, operationID string) (*response.BalanceResponse, error)

Input Parameters

Parameter

Type

Description

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

UserInput Object

Parameter

Type

Description

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.

Response
In addition to the fields described in the BaseResponse, it has the following fields, which will only be valid if the status is done:

Parameter

Type

Description

balance

Balance

An object containing the account's balance information.

Data.GetTransactions

Method is used to retrieve transactions that user has performed over a specific period of time from their bank account. The transaction list is unfiltered, meaning the response will contain all the transactions performed by the user (not just the transactions performed using your app).

Date range of the transactions that can be retrieved varies for each bank. The range supported by the users bank is shown in the response parameter transactionRange of Get Accounts Metadata endpoint.

Method Description

func (*Data) GetTransactions(accessToken string, userSecret string, accountID string, fromDate time.Time, toDate time.Time, userInputs []response.UserInput, operationID string) (*response.TransactionsResponse, error)

Input Parameters

Parameter

Type

Description

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

UserInput Object

Parameter

Type

Description

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.

Response
In addition to the fields described in the BaseResponse, it has the following fields, which will only be valid if the status is done:

Parameter

Type

Description

transactions

Transaction[]

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

Payment.GetBeneficiaries

This method is used to retrieve a list of all the beneficiaries already added for a user within a financial institution.
Method Description

func (*Payment) GetBeneficiaries(accessToken string, userSecret string, userInputs []response.UserInput, operationID string) (*response.BeneficiariesResponse, error)

Input Parameters

Parameter

Type

Description

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

UserInput Object

Parameter

Type

Description

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.

Response
In addition to the fields described in the BaseResponse, it has the following fields, which will only be returned if the status is done:

Parameter

Type

Description

beneficiaries

[]Beneficiary

An array containing the beneficiary information.

Payment.CreateBeneficiary

This method is used to retrieve a list of all the beneficiaries already added for a user within a financial institution.
Method Description

func (*Payment) CreateBeneficiary(accessToken string, userSecret string, beneficiary request.CreateBeneficiaryInfo, userInputs []response.UserInput, operationID string) (*response.BaseResponse, error)

Input Parameters

Parameter

Type

Description

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

UserInput Object

Parameter

Type

Description

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.

request.CreateBeneficiaryInfo Object

Parameter

Type

Description

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.

address Object

Parameter

Type

Description

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.

Response
Method returns only the fields defined in the BaseResponse.

Payment.CreateTransfer

This method is used to initiate a new payment from one account to another account.

🚧

Note

We suggest you use transferAutoflow method instead to initiate a payment. transferAutoflow abstracts all the validations and processing logic, required to initiate a transaction using createTransfer method.

You can read about transferAutoFlow further in the document.

Method Description

func (*Payment) CreateTransfer(accessToken string, userSecret string, transfer CreateTransfer, userInputs []response.UserInput, operationID string) (*response.TransferResponse, error)

Input Parameters

Parameter

Type

Description

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

UserInput Object

Parameter

Type

Description

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.

CreateTransfer Object

Parameter

Type

Description

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.

Response
In addition to the fields described in the BaseResponse, it has the following fields, which will only be returned if the status is done:

Parameter

Type

Description

reference

String

Transaction reference string returned by the bank.

Payment.TransferAutoflow

This method is used to initiate a new payment from one account to another account, without having to care nor handle any special cases or scenarios.
Method Description

func (*Payment) TransferAutoflow(accessToken string, userSecret string, transfer TransferAutoflow, userInputs []response.UserInput, operationID string) (*response.TransferResponse, error)

Input Parameters

Parameter

Type

Description

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

UserInput Object

Parameter

Type

Description

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.

TransferAutoflow Object

Parameter

Type

Description

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.

beneficiary Object

Parameter

Type

Description

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

address Object

Parameter

Type

Description

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.

Response
In addition to the fields described in the BaseResponse, it has the following fields, which will only be returned if the status is done:

Parameter

Type

Description

reference

String

Transaction reference string returned by the bank.