mirror of https://github.com/hanzo-fi/stack.git synced 2026-10-30 20:34:43 +00:00

Files

T

Maxence MaireauxandPaul Nicolas 3db27aced8 feat(wallets): Add idempotency key in wallets (#1631 )

Co-authored-by: Paul Nicolas <[email protected]>

2024-08-02 18:06:45 +02:00

42 KiB

Raw Permalink Blame History

Wallets

(Wallets)

Available Operations

ConfirmHold - Confirm a hold
CreateBalance - Create a balance
CreateWallet - Create a new wallet
CreditWallet - Credit a wallet
DebitWallet - Debit a wallet
GetBalance - Get detailed balance
GetHold - Get a hold
GetHolds - Get all holds for a wallet
GetTransactions
GetWallet - Get a wallet
GetWalletSummary - Get wallet summary
ListBalances - List balances of a wallet
ListWallets - List all wallets
UpdateWallet - Update a wallet
VoidHold - Cancel a hold
WalletsgetServerInfo - Get server info

ConfirmHold

Confirm a hold

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"math/big"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.ConfirmHoldRequest{
        ConfirmHoldRequest: &shared.ConfirmHoldRequest{
            Amount: big.NewInt(100),
            Final: v2.Bool(true),
        },
        HoldID: "<value>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.ConfirmHold(ctx, request)
    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.
`request`	operations.ConfirmHoldRequest	✔️	The request object to use for the request.

Response

*operations.ConfirmHoldResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

CreateBalance

Create a balance

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.CreateBalanceRequest{
        ID: "<id>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.CreateBalance(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.CreateBalanceResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.CreateBalanceRequest	✔️	The request object to use for the request.

Response

*operations.CreateBalanceResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

CreateWallet

Create a new wallet

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.CreateWalletRequest{}
    
    ctx := context.Background()
    res, err := s.Wallets.CreateWallet(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.CreateWalletResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.CreateWalletRequest	✔️	The request object to use for the request.

Response

*operations.CreateWalletResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

CreditWallet

Credit a wallet

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"math/big"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.CreditWalletRequest{
        CreditWalletRequest: &shared.CreditWalletRequest{
            Amount: shared.Monetary{
                Amount: big.NewInt(100),
                Asset: "USD/2",
            },
            Metadata: map[string]string{
                "key": "",
            },
            Sources: []shared.Subject{
                shared.CreateSubjectLedgerAccountSubject(
                    shared.LedgerAccountSubject{
                        Identifier: "<value>",
                        Type: "<value>",
                    },
                ),
            },
        },
        ID: "<id>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.CreditWallet(ctx, request)
    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.
`request`	operations.CreditWalletRequest	✔️	The request object to use for the request.

Response

*operations.CreditWalletResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

DebitWallet

Debit a wallet

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"math/big"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.DebitWalletRequest{
        DebitWalletRequest: &shared.DebitWalletRequest{
            Amount: shared.Monetary{
                Amount: big.NewInt(100),
                Asset: "USD/2",
            },
            Metadata: map[string]string{
                "key": "",
            },
            Pending: v2.Bool(true),
        },
        ID: "<id>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.DebitWallet(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.DebitWalletResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.DebitWalletRequest	✔️	The request object to use for the request.

Response

*operations.DebitWalletResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

GetBalance

Get detailed balance

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.GetBalanceRequest{
        BalanceName: "<value>",
        ID: "<id>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.GetBalance(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.GetBalanceResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetBalanceRequest	✔️	The request object to use for the request.

Response

*operations.GetBalanceResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

GetHold

Get a hold

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.GetHoldRequest{
        HoldID: "<value>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.GetHold(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.GetHoldResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetHoldRequest	✔️	The request object to use for the request.

Response

*operations.GetHoldResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

GetHolds

Get all holds for a wallet

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.GetHoldsRequest{
        Cursor: v2.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="),
        Metadata: map[string]string{
            "admin": "true",
        },
        PageSize: v2.Int64(100),
        WalletID: v2.String("wallet1"),
    }
    
    ctx := context.Background()
    res, err := s.Wallets.GetHolds(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.GetHoldsResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetHoldsRequest	✔️	The request object to use for the request.

Response

*operations.GetHoldsResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

GetTransactions

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.GetTransactionsRequest{
        Cursor: v2.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="),
        PageSize: v2.Int64(100),
        WalletID: v2.String("wallet1"),
    }
    
    ctx := context.Background()
    res, err := s.Wallets.GetTransactions(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.GetTransactionsResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetTransactionsRequest	✔️	The request object to use for the request.

Response

*operations.GetTransactionsResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

GetWallet

Get a wallet

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.GetWalletRequest{
        ID: "<id>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.GetWallet(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.GetWalletResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetWalletRequest	✔️	The request object to use for the request.

Response

*operations.GetWalletResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

GetWalletSummary

Get wallet summary

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.GetWalletSummaryRequest{
        ID: "<id>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.GetWalletSummary(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.GetWalletSummaryResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetWalletSummaryRequest	✔️	The request object to use for the request.

Response

*operations.GetWalletSummaryResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

ListBalances

List balances of a wallet

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.ListBalancesRequest{
        ID: "<id>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.ListBalances(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.ListBalancesResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.ListBalancesRequest	✔️	The request object to use for the request.

Response

*operations.ListBalancesResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

ListWallets

List all wallets

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.ListWalletsRequest{
        Cursor: v2.String("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="),
        Expand: v2.String("balances"),
        Metadata: map[string]string{
            "admin": "true",
        },
        Name: v2.String("wallet1"),
        PageSize: v2.Int64(100),
    }
    
    ctx := context.Background()
    res, err := s.Wallets.ListWallets(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.ListWalletsResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.ListWalletsRequest	✔️	The request object to use for the request.

Response

*operations.ListWalletsResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

UpdateWallet

Update a wallet

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.UpdateWalletRequest{
        ID: "<id>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.UpdateWallet(ctx, request)
    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.
`request`	operations.UpdateWalletRequest	✔️	The request object to use for the request.

Response

*operations.UpdateWalletResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

VoidHold

Cancel a hold

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )

    request := operations.VoidHoldRequest{
        HoldID: "<value>",
    }
    
    ctx := context.Background()
    res, err := s.Wallets.VoidHold(ctx, request)
    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.
`request`	operations.VoidHoldRequest	✔️	The request object to use for the request.

Response

*operations.VoidHoldResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

WalletsgetServerInfo

Get server info

Example Usage

package main

import(
	"github.com/formancehq/formance-sdk-go/v2/pkg/models/shared"
	"github.com/formancehq/formance-sdk-go/v2"
	"context"
	"log"
)

func main() {
    s := v2.New(
        v2.WithSecurity(shared.Security{
            Authorization: "<YOUR_AUTHORIZATION_HERE>",
        }),
    )


    
    ctx := context.Background()
    res, err := s.Wallets.WalletsgetServerInfo(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.ServerInfo != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.

Response

*operations.WalletsgetServerInfoResponse, error

Error Object	Status Code	Content Type
sdkerrors.WalletsErrorResponse	default	application/json
sdkerrors.SDKError	4xx-5xx	/

42 KiB Raw Permalink Blame History

Wallets

Available Operations

ConfirmHold

Example Usage

Parameters

Response

CreateBalance

Example Usage

Parameters

Response

CreateWallet

Example Usage

Parameters

Response

CreditWallet

Example Usage

Parameters

Response

DebitWallet

Example Usage

Parameters

Response

GetBalance

Example Usage

Parameters

Response

GetHold

Example Usage

Parameters

Response

GetHolds

Example Usage

Parameters

Response

GetTransactions

Example Usage

Parameters

Response

GetWallet

Example Usage

Parameters

Response

GetWalletSummary

Example Usage

Parameters

Response

ListBalances

Example Usage

Parameters

Response

ListWallets

Example Usage

Parameters

Response

UpdateWallet

Example Usage

Parameters

Response

VoidHold

Example Usage

Parameters

Response

WalletsgetServerInfo

Example Usage

Parameters

Response

42 KiB

Raw Permalink Blame History