Java 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 | Boolean | 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
DapiApp.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
public ExchangeTokenResponse exchangeToken(String accessCode, String connectionID) throws IOException
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. |
DapiApp.getIdentity
This method is used to retrieve personal details about the user.
Method Description
public GetIdentityResponse getIdentity(String accessToken, String userSecret) throws IOException
public GetIdentityResponse getIdentity(String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
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. |
DapiApp.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
public GetAccountsResponse getAccounts(String accessToken, String userSecret) throws IOException
public GetAccountsResponse getAccounts(String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
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. |
DapiApp.getBalance
This method is used to retrieve balance on specific bank account of the user.
Method Description
public GetBalanceResponse getBalance(String accountID, String accessToken, String userSecret) throws IOException
public GetBalanceResponse getBalance(String accountID, String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
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. |
DapiApp.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
public GetTransactionsResponse getTransactions(String accountID, LocalDate fromDate, LocalDate toDate, String accessToken, String userSecret) throws IOException
public GetTransactionsResponse getTransactions(String accountID, LocalDate fromDate, LocalDate toDate, String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
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. |
DapiApp.getCategorizedTransactions
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).
Every transaction in the response is categorized. Transaction categories stay the same across all banks.
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
public GetCategorizedTransactionsResponse getCategorizedTransactions(String accountID, LocalDate fromDate, LocalDate toDate, String accessToken, String userSecret) throws IOException
public GetCategorizedTransactionsResponse getCategorizedTransactions(String accountID, LocalDate fromDate, LocalDate toDate, String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
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 | CategorizedTransaction[] | Array containing the transactional data for the specified account within the specified period, plus category information. |
DapiApp.getEnrichedTransactions
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).
Every transaction in the response is categorized and has further details about the brand that the transfer is associated with. Transaction categories stay the same across all banks.
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
public GetEnrichedTransactionsResponse getEnrichedTransactions(String accountID, LocalDate fromDate, LocalDate toDate, String accessToken, String userSecret) throws IOException
public GetEnrichedTransactionsResponse getEnrichedTransactions(String accountID, LocalDate fromDate, LocalDate toDate, String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
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 | EnrichedTransaction[] | Array containing the transactional data for the specified account within the specified period, plus category information & brand details. |
DapiApp.getBeneficiaries
This method is used to retrieve a list of all the beneficiaries already added for a user within a financial institution.
Method Description
public GetBeneficiariesResponse getBeneficiaries(String accessToken, String userSecret) throws IOException
public GetBeneficiariesResponse getBeneficiaries(String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
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. |
DapiApp.createBeneficiary
This method is used to retrieve a list of all the beneficiaries already added for a user within a financial institution.
Method Description
public CreateBeneficiaryResponse createBeneficiary(Payment.BeneficiaryInfo beneficiary, String accessToken, String userSecret) throws IOException
public CreateBeneficiaryResponse createBeneficiary(Payment.BeneficiaryInfo beneficiary, String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
Input Parameters
| Parameter | Type | Description |
|---|---|---|
| beneficiary REQUIRED | Payment.BeneficiaryInfo | 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. |
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. |
DapiApp.createTransfer
This method is used to initiate a new payment from one account to another account.
Note
We suggest you use
transferAutoflowmethod instead to initiate a payment.transferAutoflowabstracts all the validations and processing logic, required to initiate a transaction usingcreateTransfermethod.You can read about
transferAutoFlowfurther in the document.
Method Description
public CreateTransferResponse createTransfer(Payment.Transfer transfer, String accessToken, String userSecret) throws IOException
public CreateTransferResponse createTransfer(Payment.Transfer transfer, String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
Input Parameters
| Parameter | Type | Description |
|---|---|---|
| transfer REQUIRED | Payment.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. |
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. |
DapiApp.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
public TransferAutoflowResponse transferAutoflow(Payment.TransferAutoflow transferAutoflow, String accessToken, String userSecret) throws IOException
public TransferAutoflowResponse transferAutoflow(Payment.TransferAutoflow transferAutoflow, String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
Input Parameters
| Parameter | Type | Description |
|---|---|---|
| transfer REQUIRED | Payment.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. |
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. |
ACH
ach.createPull
Method is used to create an ACH Pull transaction
Method Description
public CreatePullResponse createPull(CreatePull transfer, String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
Input Parameters
| Name | Type | Description |
|---|---|---|
| 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 |
Transfer Object
| Name | Type | Description |
|---|---|---|
| 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. |
UserInputs Object
| Name | Type | Description |
|---|---|---|
| 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. |
Response
Method returns standard Base Response. You can find description of standard response in the beginning of the document.
ach.getPull
Method is used to get an existing ACH Pull transaction
Method Description
public GetPullResponse getPull(String accessToken, String userSecret, String operationID, UserInput[] userInputs) throws IOException
Input Parameters
| Name | Type | Description |
|---|---|---|
| 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 |
Response
| Name | Type | Description |
|---|---|---|
| transfer | Object<Transfer> | Details of the ACH transfer |
Transfer Object
| Name | Type | Description |
|---|---|---|
| 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 |
Currency Object
| Name | Type | Description |
|---|---|---|
| Code | String | Currency code |
| Name | String | Full name of the Currency |
Updated 12 months ago