fdx/fdx-api-sdk-php

FDX API for SDK generation

1.0.0 2025-10-30 13:03 UTC

Requires

• php: ^7.2 || ^8.0
• ext-curl: *
• ext-json: *
• apimatic/core: ~0.3.13
• apimatic/core-interfaces: ~0.1.5
• apimatic/unirest-php: ^4.0.6

Requires (Dev)

• phan/phan: 5.4.5
• squizlabs/php_codesniffer: ^3.5

MIT

• Muhammad Rafay

README

Introduction

Financial Data Exchange V6.2.0 Consent API

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "fdx/fdx-api-sdk-php:1.0.0"

Or add it to the composer.json file manually as given below:

"require": {
    "fdx/fdx-api-sdk-php": "1.0.0"
}

You can also view the package at: https://packagist.org/packages/fdx/fdx-api-sdk-php#1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. Default: Environment.PRODUCTION
timeout	int	Timeout for API calls in seconds. Default: 0
enableRetries	bool	Whether to enable retries and backoff feature. Default: false
numberOfRetries	int	The number of retries to make. Default: 0
retryInterval	float	The retry time interval between the endpoint calls. Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries. Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests. Default: 0
retryOnTimeout	bool	Whether to retry on request timeout. Default: true
httpStatusCodesToRetry	array	Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against. Default: 'GET', 'PUT'
loggingConfiguration	LoggingConfigurationBuilder	Represents the logging configurations for API calls
proxyConfiguration	ProxyConfigurationBuilder	Represents the proxy configurations for API calls
bearerAuthCredentials	BearerAuthCredentials	The Credentials Setter for OAuth 2 Bearer token
taxBasicAuthCredentials	TaxBasicAuthCredentials	The Credentials Setter for Basic Authentication

The API client can be initialized as follows:

use FdxApiLib\Logging\LoggingConfigurationBuilder;
use FdxApiLib\Logging\RequestLoggingConfigurationBuilder;
use FdxApiLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use FdxApiLib\Environment;
use FdxApiLib\Authentication\BearerAuthCredentialsBuilder;
use FdxApiLib\Authentication\TaxBasicAuthCredentialsBuilder;
use FdxApiLib\FdxApiClientBuilder;

$client = FdxApiClientBuilder::init()
    ->bearerAuthCredentials(
        BearerAuthCredentialsBuilder::init(
            'AccessToken'
        )
    )
    ->taxBasicAuthCredentials(
        TaxBasicAuthCredentialsBuilder::init(
            'Username',
            'Password'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

Authorization

This API uses the following authentication schemes.

• bearerAuth (OAuth 2 Bearer token)
• TaxBasicAuth (Basic Authentication)

List of APIs

• User Consent
• Account Information
• Account Statements
• Account Transactions
• Money Movement
• Personal Information
• Reward Program Categories
• Reward Program Information
• Event Notifications
• Fraud Notification
• Internal Transfers
• Payee Management
• Payment Initiation Parties
• Recurring Payments
• Payroll Information
• Submit Tax Forms
• Tax Forms
• Resource Information
• Meta
• Payments
• Recipients

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse