formance/formance-sdk

Maintainers

Details

github.com/formancehq/formance-sdk-php

Source

Issues

Installs: 893

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 0

Open Issues: 1

v3.1.0 2024-09-25 11:53 UTC

Requires

Requires (Dev)

MIT ff6670b20f2bd084acce2b4992725799c82cd8cf

This package is auto-updated.

Last update: 2024-12-04 00:09:19 UTC

README

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

Summary

Formance Stack API: Open, modular foundation for unique payments flows

Introduction

This API is documented in OpenAPI format.

Authentication

Formance Stack offers one forms of authentication:

  • OAuth2 OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.

Table of Contents

SDK Installation

The SDK relies on Composer to manage its dependencies.

To install the SDK and add it as a dependency to an existing composer.json file:

composer require "formance/formance-sdk"

SDK Example Usage

Example

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;

$sdk = stack\SDK::builder()->build();

try {
    $requestSecurity = new Operations\GetVersionsSecurity(
        authorization: "<YOUR_AUTHORIZATION_HERE>",
    );
    $response = $sdk->getVersions($requestSecurity);

    if ($response->getVersionsResponse !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Available Resources and Operations

Available methods

Auth

Ledger

Orchestration

Payments

Reconciliation

SDK

SDKOrchestrationV1

SDKPaymentsV1

SDKReconciliationV1

SDKSearchV1

SDKV1

SDKV2

SDKWalletsV1

SDKWebhooksV1

Search

V1

V2

Wallets

Webhooks

Server Selection

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

Variables

Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:

  • environment: stack\ServerEnvironment
  • organization: string

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy