Python Library Reference
Disclaimer
Dapi's API request and response params are in
camelCase
, so while this library followsPEP8
standard and usessnake_case
for all arguments, all responses will be incamelCase
.
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 |
| Unique ID generated to identify a specific operation. |
success |
| Returns |
status |
| The status of the job.
|
userInputs |
| 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 |
type |
| Type of error encountered. |
msg |
| Detailed description of the error. Note: It's only returned if operation status is |
UserInput Object
Parameter | Type | Description |
---|---|---|
id |
| Type of input required. You can read more about user input types on User Input Types. |
query |
| Textual description of what is required from the user side. |
index |
| Is used in case more than one user input is requested. |
answer |
| 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
def exchangeToken(access_code, connection_id) -> dict
Input Parameters
Parameter | Type | Description |
---|---|---|
access_code |
| Unique code for a user’s successful login to |
connection_id |
| The |
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 |
| A unique permanent token linked to the user. |
DapiApp.getIdentity
This method is used to retrieve personal details about the user.
Method Description
def getIdentity(access_token, user_secret, user_inputs=[], operation_id="") -> dict
Method Description
Parameter | Type | Description |
---|---|---|
access_token |
| Access Token obtained using the |
user_secret |
| The |
operation_id |
| The |
user_inputs |
| Array of You can read more about user inputs specification onSpecify User Input |
UserInput Object
Parameter | Type | Description |
---|---|---|
id |
| Type of input required. You can read more about user input types on User Input Types. |
index |
| Is used in case more than one user input is requested. |
answer |
| 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 |
| 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
def getAccounts(access_token, user_secret, user_inputs=[], operation_id="") -> dict
Input Parameters
Parameter | Type | Description |
---|---|---|
access_token |
| Access Token obtained using the |
user_secret |
| The |
operation_id |
| The |
user_inputs |
| Array of You can read more about user inputs specification on Specify User Input |
UserInput Object
Parameter | Type | Description |
---|---|---|
id |
| Type of input required. You can read more about user input types on User Input Types. |
index |
| Is used in case more than one user input is requested. |
answer |
| 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 |
| 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
def getBalance(access_token, user_secret, account_id, user_inputs=[], operation_id="") -> dict
Input Parameters
Parameter | Type | Description |
---|---|---|
account_id |
| The bank account ID which its balance is requested. |
access_token |
| Access Token obtained using the |
user_secret |
| The |
operation_id |
| The |
user_inputs |
| Array of You can read more about user inputs specification on Specify User Input |
UserInput Object
Parameter | Type | Description |
---|---|---|
id |
| Type of input required. You can read more about user input types on User Input Types. |
index |
| Is used in case more than one user input is requested. |
answer |
| 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 |
| 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
def getTransactions(access_token, user_secret, account_id, from_date, to_date, user_inputs=[], operation_id="") -> dict
Input Parameters
Parameter | Type | Description |
---|---|---|
account_id |
| The bank account ID which its transactions are requested. |
from_date |
| The start date of the transactions wanted. |
to_date |
| The end date of the transactions wanted. |
access_token |
| Access Token obtained using the |
user_secret |
| The |
operation_id |
| The |
user_inputs |
| Array of You can read more about user inputs specification on Specify User Input |
UserInput Object
Parameter | Type | Description |
---|---|---|
id |
| Type of input required. You can read more about user input types on User Input Types. |
index |
| Is used in case more than one user input is requested. |
answer |
| 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 |
| Array containing the transactional data for the specified account within the specified period. |
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
def getBeneficiaries(access_token, user_secret, user_inputs=[], operation_id="") -> dict
Input Parameters
Parameter | Type | Description |
---|---|---|
access_token |
| Access Token obtained using the |
user_secret |
| The |
operation_id |
| The |
user_inputs |
| Array of You can read more about user inputs specification on Specify User Input |
UserInput Object
Parameter | Type | Description |
---|---|---|
id |
| Type of input required. You can read more about user input types on User Input Types. |
index |
| Is used in case more than one user input is requested. |
answer |
| 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 |
| 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
def createBeneficiary(access_token, user_secret, beneficiary_data, user_inputs=[], operation_id="") -> dict
Input Parameters
Parameter | Type | Description |
---|---|---|
beneficiary_data |
| An object that contains info about the beneficiary that should be added. |
access_token |
| Access Token obtained using the |
user_secret |
| The |
operation_id |
| The |
user_inputs |
| Array of You can read more about user inputs specification on Specify User Input |
UserInput Object
Parameter | Type | Description |
---|---|---|
id |
| Type of input required. You can read more about user input types on User Input Types. |
index |
| Is used in case more than one user input is requested. |
answer |
| User input that must be submitted. In the response it will always be empty. |
beneficiary_data Object
Parameter | Type | Description |
---|---|---|
name |
| Name of the beneficiary. |
nickname |
| Nickname of the beneficiary. |
accountNumber |
| Account number of the beneficiary. |
iban |
| Beneficiary's IBAN number. |
swiftCode |
| Beneficiary's financial institution's SWIFT code. |
type |
| Type of beneficiary. |
address |
| An object containing the address information of the beneficiary. |
country |
| Name of the country in all uppercase letters. |
branchAddress |
| Address of the financial institution’s specific branch. |
branchName |
| Name of the financial institution’s specific branch. |
phoneNumber |
| Beneficiary's phone number. |
routingNumber |
| Beneficiary's Routing number, needed only for US banks accounts. |
address Object
Parameter | Type | Description |
---|---|---|
line1 |
| Street name and number. Note: value should not contain any commas or special characters. |
line2 |
| City name. Note: value should not contain any commas or special characters. |
line3 |
| 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 usingcreateTransfer
method.You can read about
transferAutoFlow
further in the document.
Method Description
def createTransfer(access_token, user_secret, transfer_data, user_inputs=[], operation_id="") -> dict
Input Parameters
Parameter | Type | Description |
---|---|---|
transfer_data |
| An object that contains info about the transfer that should be initiated, and any other details that's used to automate the operation. |
access_token |
| Access Token obtained using the |
user_secret |
| The |
operation_id |
| The |
user_inputs |
| Array of You can read more about user inputs specification on Specify User Input |
UserInput Object
Parameter | Type | Description |
---|---|---|
id |
| Type of input required. You can read more about user input types on User Input Types. |
index |
| Is used in case more than one user input is requested. |
answer |
| User input that must be submitted. In the response it will always be empty. |
transfer_data Object
Parameter | Type | Description |
---|---|---|
senderID |
| The id of the account which the money should be sent from. |
amount |
| The amount of money which should be sent. |
receiverID |
| The id of the beneficiary which the money should be sent to. |
name |
| The name of receiver. |
accountNumber |
| The Account Number of the receiver's account. |
iban |
| The IBAN of the receiver's account. |
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 |
| 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
def transferAutoflow(access_token, user_secret, transfer_autoflow_data, user_inputs=[], operation_id="") -> dict
Input Parameters
Parameter | Type | Description |
---|---|---|
transfer_autoflow_data |
| An object that contains info about the transfer that should be initiated, and any other details that's used to automate the operation. |
access_token |
| Access Token obtained using the |
user_secret |
| The |
operation_id |
| The |
user_inputs |
| Array of You can read more about user inputs specification on Specify User Input |
UserInput Object
Parameter | Type | Description |
---|---|---|
id |
| Type of input required. You can read more about user input types on User Input Types. |
index |
| Is used in case more than one user input is requested. |
answer |
| User input that must be submitted. In the response it will always be empty. |
transfer_autoflow_data Object
Parameter | Type | Description |
---|---|---|
senderID |
| The id of the account which the money should be sent from. |
amount |
| The amount of money which should be sent. |
beneficiary |
| An object that holds the info about the beneficiary which the money should be sent to. |
bankID |
| The bankID of the user which is initiating this transfer. |
beneficiary Object
Parameter | Type | Description |
---|---|---|
name |
| Name of the beneficiary. |
nickname |
| Nickname of the beneficiary. |
accountNumber |
| Account number of the beneficiary. |
iban |
| Beneficiary's IBAN number. |
swiftCode |
| Beneficiary's financial institution's SWIFT code. |
address |
| An object containing the address information of the beneficiary. |
country |
| Name of the country in all uppercase letters. |
branchAddress |
| Address of the financial institution’s specific branch. |
branchName |
| Name of the financial institution’s specific branch. |
phoneNumber |
| Beneficiary's phone number. |
routingNumber |
| Beneficiary's Routing number, needed only for US banks accounts |
address Object
Parameter | Type | Description |
---|---|---|
line1 |
| Street name and number. Note: value should not contain any commas or special characters. |
line2 |
| City name. Note: value should not contain any commas or special characters. |
line3 |
| 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 |
| Transaction reference string returned by the bank. |
Updated 10 months ago