Download the PHP package dapi-co/dapi-php without Composer

On this page you can find all versions of the php package dapi-co/dapi-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
dapi-co/dapi-php
Rate from 1 - 5
Rated 5.00 based on 1 reviews

Example code of dapi-co/dapi-php

Informations about the package dapi-php

dapi-php

A PHP library that talks to the Dapi API.

Quickstart

Configure Project

First add the library module to your project using composer. Add the following in your composer.json

OR simply type this in your project folder.

Configure Library

  1. Create a DapiClient with your App Secret.

  2. Now you can use any of the functions of the products available on the client (data for example) instance to call Dapi with your appSecret.

  3. Or, you can use the handleSDKRequests function of the client instance inside an endpoint in your server. Our code will basically update the request to add your app's appSecret to it, and forward the request to Dapi, then return the result.

DAPI API

A list of all options on Dapi's PHP Library that your backend can call to perform some operations.

Reference

BaseResponse

All the responses have the fields described here. 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 string The status of the job.

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

For further explanation see Operation Statuses.
userInputs array Array of userInput objects, that are needed to complete this operation.

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 string 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
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 connectionID 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

Method is used to retrieve personal details about the user.

Method Description
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		 array 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 string 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.
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 array An object (associative array) 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
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		 array 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 string 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.
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 array An array containing the accounts data of the user.

data->getBalance

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

Method Description
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		 array 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 string 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.
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 (associative array) 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
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		 string The start date of the transactions wanted.
It should be in this format: YYYY-MM-DD
toDate
REQUIRED		 string The end date of the transactions wanted.
It should be in this format: YYYY-MM-DD
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		 array 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 string 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.
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 Array containing the transactional data for the specified account within the specified period.

payment->getBeneficiaries

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

Method Description
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		 array 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 string 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.
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 array An array containing the beneficiary information.

payment->createBeneficiary

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

Method Description
Input Parameters
Parameter Type Description
beneficiaryData
REQUIRED		 array An object (associative array) 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		 array 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 string 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.
beneficiaryData object
Parameter Type Description
name
REQUIRED		 string Name 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		 string Type of beneficiary.
For further explanation see Beneficiary Types.
address
REQUIRED		 array An object (associative arry) 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

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

Important

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
Input Parameters
Parameter Type Description
transferData
REQUIRED		 array An object (associative array) that contains info about the transfer that should be initiated.
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		 array 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 string 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.
transferData 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

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
Input Parameters
Parameter Type Description
transferAutoflowData
REQUIRED		 array An object (associative array) 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		 array 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 string 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.
transferAutoflowData 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		 float The amount of money which should be sent.
beneficiary
REQUIRED		 array An object (associative) 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.
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		 string Type of beneficiary.
For further explanation see Beneficiary Types.
address
REQUIRED		 array An object (associative arry) 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.

All versions of dapi-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2.5 || ^8.0
guzzlehttp/guzzle Version ^7.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package dapi-co/dapi-php contains the following files

Loading the files please wait ....