hanzo-fi/payments
1
0
Fork 0
mirror of https://github.com/hanzo-fi/payments.git synced 2026-10-30 20:31:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
payments/pkg/client/docs/sdks/v3
T
History
zeekay 7d727874d5 chore: rebrand Formance Payments -> Hanzo Payments (hanzo-fi) 
- go.mod module path + all self-imports: github.com/formancehq/payments -> github.com/hanzo-fi/payments
  (1590 .go files / 3152 refs; 20 modules: root, pkg/client, pkg/domain, 18 ce/plugins).
  External dep kept: formancehq/go-libs.
- plugins: each ce/plugins/* consumed a *published* pkg/domain; added local
  'replace .../pkg/domain => ../../../pkg/domain' (consistent with root) so every
  standalone plugin module builds in-monorepo. compile-plugin.sh MOD var rebranded too.
- branding: README, LICENSE (dual MIT+EE; upstream copyright retained + Hanzo added),
  goreleaser (release images -> registry.hanzo.ai/hanzo-fi, OCI labels, homepage),
  proto go_package, renovate, speakeasy gen.yaml, connector-template *.gotpl.
- CI: removed Numary/Formance workflows + composite action; added canonical hanzo.yml +
  cicd.yml (hanzoai/ci, gated HANZO_CI_ENABLED) + secretless ci.yml (go build/vet).
- kept as data/compat keys: wire capability enums ALLOW_FORMANCE_*, generated SDK type
  client.Formance, domain field FormanceRedirectURL, OTEL_SERVICE_NAME, upstream base image.
- verified: go build ./... (default + -tags ee) + all 20 nested modules green.
2026-07-05 13:08:55 -07:00
..
README.md
chore: rebrand Formance Payments -> Hanzo Payments (hanzo-fi)
2026-07-05 13:08:55 -07:00

README.md

V3

(Payments.V3)

Overview

Available Operations

CreateAccount

Create a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.CreateAccount(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3CreateAccountResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request components.V3CreateAccountRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.V3CreateAccountResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListAccounts

List all accounts

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListAccounts(ctx, client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3AccountsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListAccountsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetAccount

Get an account by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetAccount(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3GetAccountResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
accountID string ✔️ The account ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetAccountResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetAccountBalances

Get account balances

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"github.com/hanzo-fi/payments/pkg/client/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetAccountBalances(ctx, operations.V3GetAccountBalancesRequest{
        AccountID: "<id>",
        PageSize: client.Int64(100),
        Cursor: client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V3BalancesCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V3GetAccountBalancesRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetAccountBalancesResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

CreateBankAccount

Create a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.CreateBankAccount(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3CreateBankAccountResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request components.V3CreateBankAccountRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.V3CreateBankAccountResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListBankAccounts

List all bank accounts

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListBankAccounts(ctx, client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3BankAccountsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListBankAccountsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetBankAccount

Get a Bank Account by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetBankAccount(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3GetBankAccountResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
bankAccountID string ✔️ The bank account ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetBankAccountResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

UpdateBankAccountMetadata

Update a bank account's metadata

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.UpdateBankAccountMetadata(ctx, "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
bankAccountID string ✔️ The bank account ID
v3UpdateBankAccountMetadataRequest *components.V3UpdateBankAccountMetadataRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3UpdateBankAccountMetadataResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ForwardBankAccount

Forward a Bank Account to a PSP for creation

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ForwardBankAccount(ctx, "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ForwardBankAccountResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
bankAccountID string ✔️ The bank account ID
v3ForwardBankAccountRequest *components.V3ForwardBankAccountRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ForwardBankAccountResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListConnectors

List all connectors

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListConnectors(ctx, client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ConnectorsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListConnectorsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

InstallConnector

Install a connector

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.InstallConnector(ctx, "<value>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3InstallConnectorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
connector string ✔️ The connector to filter by
v3InstallConnectorRequest *components.V3InstallConnectorRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3InstallConnectorResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListConnectorConfigs

List all connector configurations

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListConnectorConfigs(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ConnectorConfigsResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListConnectorConfigsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListConnectorCapabilities

Returns the static map of provider name to the list of plugin capabilities (FETCH_ACCOUNTS, CREATE_TRANSFER, ...) compiled into this binary. The catalog is immutable for the lifetime of the process and is therefore safe to cache: the response carries a strong ETag and a Cache-Control: public, max-age=3600, must-revalidate directive. Stateless consumers (e.g. console) should set If-None-Match on subsequent requests to receive a 304 Not Modified.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListConnectorCapabilities(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ConnectorCapabilitiesResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
ifNoneMatch *string ➖ ETag from a previous response; a matching value yields 304 Not Modified.
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListConnectorCapabilitiesResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

UninstallConnector

Uninstall a connector

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.UninstallConnector(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3UninstallConnectorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
connectorID string ✔️ The connector ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3UninstallConnectorResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetConnectorConfig

Get a connector configuration by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetConnectorConfig(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3GetConnectorConfigResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
connectorID string ✔️ The connector ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetConnectorConfigResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

V3UpdateConnectorConfig

Update connector config

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.V3UpdateConnectorConfig(ctx, "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
connectorID string ✔️ The connector ID
v3UpdateConnectorRequest *components.V3UpdateConnectorRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3UpdateConnectorConfigResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetConnectorCapabilities

Returns the list of plugin capabilities advertised by the provider backing this installed connector (FETCH_ACCOUNTS, CREATE_TRANSFER, ...). The same values are also inlined on each row of v3ListConnectors; prefer that endpoint when listing multiple connectors.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetConnectorCapabilities(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ConnectorCapabilityResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
connectorID string ✔️ The connector ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetConnectorCapabilitiesResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ResetConnector

Reset a connector. Be aware that this will delete all data and stop all existing tasks like payment initiations and bank account creations.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ResetConnector(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ResetConnectorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
connectorID string ✔️ The connector ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ResetConnectorResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListConnectorSchedules

List all connector schedules

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListConnectorSchedules(ctx, "<id>", client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ConnectorSchedulesCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
connectorID string ✔️ The connector ID
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListConnectorSchedulesResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetConnectorSchedule

Get a connector schedule by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetConnectorSchedule(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ConnectorScheduleResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
connectorID string ✔️ The connector ID
scheduleID string ✔️ The schedule ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetConnectorScheduleResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListConnectorScheduleInstances

List all connector schedule instances

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListConnectorScheduleInstances(ctx, "<id>", "<id>", client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="))
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ConnectorScheduleInstancesCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
connectorID string ✔️ The connector ID
scheduleID string ✔️ The schedule ID
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListConnectorScheduleInstancesResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListOrders

Returns the full list of orders ingested by Formance from connectors that implement the orders capability (e.g. coinbaseprime). Orders represent trade placements on an exchange-style PSP and are read-only through the Formance API — submission, cancellation, and lifecycle transitions are owned by the underlying connector.

Results are cursor-paginated. The optional request body accepts a query builder for filtering over top-level V3Order fields such as connectorID, reference, direction, status, type, sourceAsset, destinationAsset, and createdAt.

See V3Order for the full response shape, including the adjustments array that captures each observed state transition on the exchange.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListOrders(ctx, client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3OrdersCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListOrdersResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetOrder

Returns one order identified by its Formance-assigned id (composed from the PSP reference and the connector ID — not the PSP's native reference). The response includes the full adjustments history ordered from oldest to most recent; the last adjustment reflects the order's current top-level status.

Returns an error via V3ErrorResponse when no order exists for the given ID, or when the ID cannot be decoded.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetOrder(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3GetOrderResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
orderID string ✔️ The order ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetOrderResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListConversions

Returns the full list of conversions ingested by Formance from connectors that implement the conversions capability. A conversion is a direct swap between two assets on a PSP (e.g. USD → USDC on Coinbase Prime). Conversions are read-only through the Formance API.

Unlike orders, conversions do not carry an adjustment history — Formance records only the final observed state (status, destinationAmount, and fee when settled).

Results are cursor-paginated. The optional request body accepts a query builder for filtering over top-level V3Conversion fields such as connectorID, reference, status, sourceAsset, destinationAsset, and createdAt.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListConversions(ctx, client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ConversionsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListConversionsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetConversion

Returns one conversion identified by its Formance-assigned id (not the PSP's native reference). See V3Conversion for the response shape — on COMPLETED status the destinationAmount and fee fields reflect the settled values; on FAILED the error field carries the PSP's rejection reason.

Returns an error via V3ErrorResponse when no conversion exists for the given ID.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetConversion(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3GetConversionResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
conversionID string ✔️ The conversion ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetConversionResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

CreatePayment

Create a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.CreatePayment(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3CreatePaymentResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request components.V3CreatePaymentRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.V3CreatePaymentResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListPayments

List all payments

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListPayments(ctx, client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListPaymentsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetPayment

Get a payment by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetPayment(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3GetPaymentResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentID string ✔️ The payment ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetPaymentResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

UpdatePaymentMetadata

Update a payment's metadata

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.UpdatePaymentMetadata(ctx, "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentID string ✔️ The payment ID
v3UpdatePaymentMetadataRequest *components.V3UpdatePaymentMetadataRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3UpdatePaymentMetadataResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

InitiatePayment

Initiate a payment

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.InitiatePayment(ctx, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3InitiatePaymentResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
noValidation *bool ➖ If set to true, the request will not have to be validated. This is useful if we want to directly forward the request to the PSP.
v3InitiatePaymentRequest *components.V3InitiatePaymentRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3InitiatePaymentResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListPaymentInitiations

List all payment initiations

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListPaymentInitiations(ctx, client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentInitiationsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListPaymentInitiationsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

DeletePaymentInitiation

Delete a payment initiation by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.DeletePaymentInitiation(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentInitiationID string ✔️ The payment initiation ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3DeletePaymentInitiationResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetPaymentInitiation

Get a payment initiation by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetPaymentInitiation(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3GetPaymentInitiationResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentInitiationID string ✔️ The payment initiation ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetPaymentInitiationResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

RetryPaymentInitiation

Retry a payment initiation

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.RetryPaymentInitiation(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3RetryPaymentInitiationResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentInitiationID string ✔️ The payment initiation ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3RetryPaymentInitiationResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ApprovePaymentInitiation

Approve a payment initiation

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ApprovePaymentInitiation(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ApprovePaymentInitiationResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentInitiationID string ✔️ The payment initiation ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ApprovePaymentInitiationResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

RejectPaymentInitiation

Reject a payment initiation

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.RejectPaymentInitiation(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentInitiationID string ✔️ The payment initiation ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3RejectPaymentInitiationResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ReversePaymentInitiation

Reverse a payment initiation

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ReversePaymentInitiation(ctx, "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ReversePaymentInitiationResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentInitiationID string ✔️ The payment initiation ID
v3ReversePaymentInitiationRequest *components.V3ReversePaymentInitiationRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ReversePaymentInitiationResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListPaymentInitiationAdjustments

List all payment initiation adjustments

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListPaymentInitiationAdjustments(ctx, "<id>", client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentInitiationAdjustmentsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
paymentInitiationID string ✔️ The payment initiation ID
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListPaymentInitiationAdjustmentsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListPaymentInitiationRelatedPayments

List all payments related to a payment initiation

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListPaymentInitiationRelatedPayments(ctx, "<id>", client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentInitiationRelatedPaymentsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
paymentInitiationID string ✔️ The payment initiation ID
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListPaymentInitiationRelatedPaymentsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

CreatePaymentServiceUser

Create a formance payment service user object

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.CreatePaymentServiceUser(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3CreatePaymentServiceUserResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request components.V3CreatePaymentServiceUserRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.V3CreatePaymentServiceUserResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListPaymentServiceUsers

List all payment service users

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListPaymentServiceUsers(ctx, client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentServiceUsersCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListPaymentServiceUsersResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetPaymentServiceUser

Get a payment service user by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetPaymentServiceUser(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3GetPaymentServiceUserResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetPaymentServiceUserResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

DeletePaymentServiceUser

Delete a payment service user by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.DeletePaymentServiceUser(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentServiceUserDeleteResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3DeletePaymentServiceUserResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListPaymentServiceUserConnections

List all connections for a payment service user

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListPaymentServiceUserConnections(ctx, "<id>", client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentServiceUserConnectionsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListPaymentServiceUserConnectionsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

DeletePaymentServiceUserConnector

Remove a payment service user from a connector, the PSU will still exist in Formance

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.DeletePaymentServiceUserConnector(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentServiceUserDeleteConnectorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
connectorID string ✔️ The connector ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3DeletePaymentServiceUserConnectorResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ForwardPaymentServiceUserToProvider

Register/forward a payment service user on/to a connector

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ForwardPaymentServiceUserToProvider(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
connectorID string ✔️ The connector ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ForwardPaymentServiceUserToProviderResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

CreateLinkForPaymentServiceUser

Create an authentication link for a payment service user on a connector, for oauth flow

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.CreateLinkForPaymentServiceUser(ctx, "<id>", "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentServiceUserCreateLinkResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
connectorID string ✔️ The connector ID
v3PaymentServiceUserCreateLinkRequest *components.V3PaymentServiceUserCreateLinkRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3CreateLinkForPaymentServiceUserResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListPaymentServiceUserConnectionsFromConnectorID

List enabled connections for a payment service user on a connector (i.e. the various banks PSUser has enabled on the connector)

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"github.com/hanzo-fi/payments/pkg/client/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListPaymentServiceUserConnectionsFromConnectorID(ctx, operations.V3ListPaymentServiceUserConnectionsFromConnectorIDRequest{
        PaymentServiceUserID: "<id>",
        ConnectorID: "<id>",
        PageSize: client.Int64(100),
        Cursor: client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentServiceUserConnectionsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V3ListPaymentServiceUserConnectionsFromConnectorIDRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListPaymentServiceUserConnectionsFromConnectorIDResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListPaymentServiceUserLinkAttemptsFromConnectorID

List all link attempts for a payment service user on a connector. Allows to check if users used the link and completed the oauth flow.

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"github.com/hanzo-fi/payments/pkg/client/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListPaymentServiceUserLinkAttemptsFromConnectorID(ctx, operations.V3ListPaymentServiceUserLinkAttemptsFromConnectorIDRequest{
        PaymentServiceUserID: "<id>",
        ConnectorID: "<id>",
        PageSize: client.Int64(100),
        Cursor: client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentServiceUserLinkAttemptsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.V3ListPaymentServiceUserLinkAttemptsFromConnectorIDRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListPaymentServiceUserLinkAttemptsFromConnectorIDResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetPaymentServiceUserLinkAttemptFromConnectorID

Get a link attempt for a payment service user on a connector

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetPaymentServiceUserLinkAttemptFromConnectorID(ctx, "<id>", "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentServiceUserLinkAttempt != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
connectorID string ✔️ The connector ID
attemptID string ✔️ The attempt ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetPaymentServiceUserLinkAttemptFromConnectorIDResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

DeletePaymentServiceUserConnectionFromConnectorID

Delete a connection for a payment service user on a connector

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.DeletePaymentServiceUserConnectionFromConnectorID(ctx, "<id>", "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentServiceUserDeleteConnectionResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
connectorID string ✔️ The connector ID
connectionID string ✔️ The connection ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3DeletePaymentServiceUserConnectionFromConnectorIDResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

UpdateLinkForPaymentServiceUserOnConnector

Update/Regenerate a link for a payment service user on a connector

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.UpdateLinkForPaymentServiceUserOnConnector(ctx, "<id>", "<id>", "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PaymentServiceUserUpdateLinkResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
connectorID string ✔️ The connector ID
connectionID string ✔️ The connection ID
v3PaymentServiceUserUpdateLinkRequest *components.V3PaymentServiceUserUpdateLinkRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3UpdateLinkForPaymentServiceUserOnConnectorResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

AddBankAccountToPaymentServiceUser

Add a bank account to a payment service user

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.AddBankAccountToPaymentServiceUser(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
bankAccountID string ✔️ The bank account ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3AddBankAccountToPaymentServiceUserResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ForwardPaymentServiceUserBankAccount

Forward a payment service user's bank account to a connector

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ForwardPaymentServiceUserBankAccount(ctx, "<id>", "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ForwardPaymentServiceUserBankAccountResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
paymentServiceUserID string ✔️ The payment service user ID
bankAccountID string ✔️ The bank account ID
v3ForwardPaymentServiceUserBankAccountRequest *components.V3ForwardPaymentServiceUserBankAccountRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ForwardPaymentServiceUserBankAccountResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

CreatePool

Create a formance pool object

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.CreatePool(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3CreatePoolResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request components.V3CreatePoolRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.V3CreatePoolResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

ListPools

List all pools

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.ListPools(ctx, client.Int64(100), client.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PoolsCursorResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
pageSize *int64 ➖ The number of items to return 100
cursor *string ➖ Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
 aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
requestBody map[string]any ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3ListPoolsResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetPool

Get a pool by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetPool(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3GetPoolResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
poolID string ✔️ The pool ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetPoolResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

DeletePool

Delete a pool by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.DeletePool(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
poolID string ✔️ The pool ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3DeletePoolResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

UpdatePoolQuery

Update the query of a pool

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.UpdatePoolQuery(ctx, "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
poolID string ✔️ The pool ID
v3UpdatePoolQueryRequest *components.V3UpdatePoolQueryRequest ➖ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.V3UpdatePoolQueryResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetPoolBalances

Get historical pool balances from a particular point in time

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetPoolBalances(ctx, "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PoolBalancesResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
poolID string ✔️ The pool ID
at *time.Time ➖ The time to filter by
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetPoolBalancesResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetPoolBalancesLatest

Get latest pool balances

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetPoolBalancesLatest(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3PoolBalancesResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
poolID string ✔️ The pool ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetPoolBalancesLatestResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

AddAccountToPool

Add an account to a pool

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.AddAccountToPool(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
poolID string ✔️ The pool ID
accountID string ✔️ The account ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3AddAccountToPoolResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

RemoveAccountFromPool

Remove an account from a pool

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.RemoveAccountFromPool(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
poolID string ✔️ The pool ID
accountID string ✔️ The account ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3RemoveAccountFromPoolResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*

GetTask

Get a task and its result by ID

Example Usage

package main

import(
	"context"
	"github.com/hanzo-fi/payments/pkg/client"
	"os"
	"log"
)

func main() {
    ctx := context.Background()

    s := client.New(
        "https://api.example.com",
        client.WithSecurity(os.Getenv("FORMANCE_AUTHORIZATION")),
    )

    res, err := s.Payments.V3.GetTask(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3GetTaskResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
taskID string ✔️ The task ID
opts []operations.Option ➖ The options for this request.

Response

*operations.V3GetTaskResponse, error

Errors

Error Type Status Code Content Type
sdkerrors.SDKError 4XX, 5XX */*
Reference in New Issue View Git Blame Copy Permalink