V3

(Payments.V3)

Overview

Available Operations

GetInfo - Show server information
CreateAccount - Create a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes.
ListAccounts - List all accounts
GetAccount - Get an account by ID
GetAccountBalances - Get account balances
CreateBankAccount - Create a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.
ListBankAccounts - List all bank accounts
GetBankAccount - Get a Bank Account by ID
UpdateBankAccountMetadata - Update a bank account's metadata
ForwardBankAccount - Forward a Bank Account to a PSP for creation
ListConnectors - List all connectors
InstallConnector - Install a connector
ListConnectorConfigs - List all connector configurations
UninstallConnector - Uninstall a connector
GetConnectorConfig - Get a connector configuration by ID
ResetConnector - Reset a connector. Be aware that this will delete all data and stop all existing tasks like payment initiations and bank account creations.
ListConnectorSchedules - List all connector schedules
GetConnectorSchedule - Get a connector schedule by ID
ListConnectorScheduleInstances - List all connector schedule instances
CreatePayment - Create a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.
ListPayments - List all payments
GetPayment - Get a payment by ID
UpdatePaymentMetadata - Update a payment's metadata
InitiatePayment - Initiate a payment
ListPaymentInitiations - List all payment initiations
DeletePaymentInitiation - Delete a payment initiation by ID
GetPaymentInitiation - Get a payment initiation by ID
RetryPaymentInitiation - Retry a payment initiation
ApprovePaymentInitiation - Approve a payment initiation
RejectPaymentInitiation - Reject a payment initiation
ReversePaymentInitiation - Reverse a payment initiation
ListPaymentInitiationAdjustments - List all payment initiation adjustments
ListPaymentInitiationRelatedPayments - List all payments related to a payment initiation
CreatePool - Create a formance pool object
ListPools - List all pools
GetPool - Get a pool by ID
DeletePool - Delete a pool by ID
GetPoolBalances - Get pool balances
AddAccountToPool - Add an account to a pool
RemoveAccountFromPool - Remove an account from a pool
GetTask - Get a task and its result by ID

GetInfo

Show server information

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.GetInfoAsync();

// handle response

Response

V3GetInfoResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

CreateAccount

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

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

V3CreateAccountRequest req = new V3CreateAccountRequest() {
    Reference = "<value>",
    ConnectorID = "<value>",
    CreatedAt = System.DateTime.Parse("2023-08-09T11:34:36.410Z"),
    AccountName = "<value>",
    Type = V3AccountTypeEnum.Unknown,
};

var res = await sdk.Payments.V3.CreateAccountAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	V3CreateAccountRequest	✔️	The request object to use for the request.

Response

Models.Requests.V3CreateAccountResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListAccounts

List all accounts

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListAccountsAsync(
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    requestBody: new Dictionary<string, object>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`PageSize`	long	➖	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`	Dictionary<String, object>	➖	N/A

Response

V3ListAccountsResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

GetAccount

Get an account by ID

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.GetAccountAsync(accountID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`AccountID`	string	✔️	The account ID

Response

Models.Requests.V3GetAccountResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

GetAccountBalances

Get account balances

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using FormanceSDK.Models.Requests;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

V3GetAccountBalancesRequest req = new V3GetAccountBalancesRequest() {
    AccountID = "<id>",
    PageSize = 100,
    Cursor = "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
};

var res = await sdk.Payments.V3.GetAccountBalancesAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	V3GetAccountBalancesRequest	✔️	The request object to use for the request.

Response

V3GetAccountBalancesResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	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

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

V3CreateBankAccountRequest req = new V3CreateBankAccountRequest() {
    Name = "<value>",
};

var res = await sdk.Payments.V3.CreateBankAccountAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	V3CreateBankAccountRequest	✔️	The request object to use for the request.

Response

Models.Requests.V3CreateBankAccountResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListBankAccounts

List all bank accounts

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListBankAccountsAsync(
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    requestBody: new Dictionary<string, object>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`PageSize`	long	➖	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`	Dictionary<String, object>	➖	N/A

Response

V3ListBankAccountsResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

GetBankAccount

Get a Bank Account by ID

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.GetBankAccountAsync(bankAccountID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`BankAccountID`	string	✔️	The bank account ID

Response

Models.Requests.V3GetBankAccountResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

UpdateBankAccountMetadata

Update a bank account's metadata

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.UpdateBankAccountMetadataAsync(
    bankAccountID: "<id>",
    v3UpdateBankAccountMetadataRequest: new Models.Components.V3UpdateBankAccountMetadataRequest() {
        Metadata = new Dictionary<string, string>() {
            { "key", "<value>" },
        },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description
`BankAccountID`	string	✔️	The bank account ID
`V3UpdateBankAccountMetadataRequest`	Models.Components.V3UpdateBankAccountMetadataRequest	➖	N/A

Response

V3UpdateBankAccountMetadataResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ForwardBankAccount

Forward a Bank Account to a PSP for creation

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ForwardBankAccountAsync(
    bankAccountID: "<id>",
    v3ForwardBankAccountRequest: new Models.Components.V3ForwardBankAccountRequest() {
        ConnectorID = "<value>",
    }
);

// handle response

Parameters

Parameter	Type	Required	Description
`BankAccountID`	string	✔️	The bank account ID
`V3ForwardBankAccountRequest`	Models.Components.V3ForwardBankAccountRequest	➖	N/A

Response

Models.Requests.V3ForwardBankAccountResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListConnectors

List all connectors

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListConnectorsAsync(
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    requestBody: new Dictionary<string, object>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`PageSize`	long	➖	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`	Dictionary<String, object>	➖	N/A

Response

V3ListConnectorsResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

InstallConnector

Install a connector

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.InstallConnectorAsync(
    connector: "<value>",
    v3InstallConnectorRequest: V3InstallConnectorRequest.CreateV3DummypayConfig(
        new V3DummypayConfig() {
            Directory = "/private/tmp",
            Name = "<value>",
        }
    )
);

// handle response

Parameters

Parameter	Type	Required	Description
`Connector`	string	✔️	The connector to filter by
`V3InstallConnectorRequest`	Models.Components.V3InstallConnectorRequest	➖	N/A

Response

Models.Requests.V3InstallConnectorResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListConnectorConfigs

List all connector configurations

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListConnectorConfigsAsync();

// handle response

Response

V3ListConnectorConfigsResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

UninstallConnector

Uninstall a connector

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.UninstallConnectorAsync(connectorID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`ConnectorID`	string	✔️	The connector ID

Response

Models.Requests.V3UninstallConnectorResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

GetConnectorConfig

Get a connector configuration by ID

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.GetConnectorConfigAsync(connectorID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`ConnectorID`	string	✔️	The connector ID

Response

Models.Requests.V3GetConnectorConfigResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	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

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ResetConnectorAsync(connectorID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`ConnectorID`	string	✔️	The connector ID

Response

Models.Requests.V3ResetConnectorResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListConnectorSchedules

List all connector schedules

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListConnectorSchedulesAsync(
    connectorID: "<id>",
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    requestBody: new Dictionary<string, object>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`ConnectorID`	string	✔️	The connector ID
`PageSize`	long	➖	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`	Dictionary<String, object>	➖	N/A

Response

V3ListConnectorSchedulesResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

GetConnectorSchedule

Get a connector schedule by ID

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.GetConnectorScheduleAsync(
    connectorID: "<id>",
    scheduleID: "<id>"
);

// handle response

Parameters

Parameter	Type	Required	Description
`ConnectorID`	string	✔️	The connector ID
`ScheduleID`	string	✔️	The schedule ID

Response

V3GetConnectorScheduleResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListConnectorScheduleInstances

List all connector schedule instances

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListConnectorScheduleInstancesAsync(
    connectorID: "<id>",
    scheduleID: "<id>",
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`ConnectorID`	string	✔️	The connector ID
`ScheduleID`	string	✔️	The schedule ID
`PageSize`	long	➖	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==

Response

V3ListConnectorScheduleInstancesResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	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

using FormanceSDK;
using FormanceSDK.Models.Components;
using System;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

V3CreatePaymentRequest req = new V3CreatePaymentRequest() {
    Reference = "<value>",
    ConnectorID = "<value>",
    CreatedAt = System.DateTime.Parse("2023-10-04T19:11:41.956Z"),
    Type = V3PaymentTypeEnum.Transfer,
    InitialAmount = 581056,
    Amount = 444061,
    Asset = "<value>",
    Scheme = "<value>",
};

var res = await sdk.Payments.V3.CreatePaymentAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	V3CreatePaymentRequest	✔️	The request object to use for the request.

Response

Models.Requests.V3CreatePaymentResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListPayments

List all payments

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListPaymentsAsync(
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    requestBody: new Dictionary<string, object>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`PageSize`	long	➖	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`	Dictionary<String, object>	➖	N/A

Response

V3ListPaymentsResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

GetPayment

Get a payment by ID

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.GetPaymentAsync(paymentID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`PaymentID`	string	✔️	The payment ID

Response

Models.Requests.V3GetPaymentResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

UpdatePaymentMetadata

Update a payment's metadata

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.UpdatePaymentMetadataAsync(
    paymentID: "<id>",
    v3UpdatePaymentMetadataRequest: new Models.Components.V3UpdatePaymentMetadataRequest() {
        Metadata = new Dictionary<string, string>() {
            { "key", "<value>" },
        },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description
`PaymentID`	string	✔️	The payment ID
`V3UpdatePaymentMetadataRequest`	Models.Components.V3UpdatePaymentMetadataRequest	➖	N/A

Response

V3UpdatePaymentMetadataResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

InitiatePayment

Initiate a payment

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.InitiatePaymentAsync(
    noValidation: false,
    v3InitiatePaymentRequest: new Models.Components.V3InitiatePaymentRequest() {
        Reference = "<value>",
        ScheduledAt = System.DateTime.Parse("2024-12-23T02:07:00.778Z"),
        ConnectorID = "<value>",
        Description = "decent uh-huh inject angrily",
        Type = V3PaymentInitiationTypeEnum.Payout,
        Amount = 645913,
        Asset = "<value>",
    }
);

// handle response

Parameters

Parameter	Type	Required	Description
`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`	Models.Components.V3InitiatePaymentRequest	➖	N/A

Response

Models.Requests.V3InitiatePaymentResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListPaymentInitiations

List all payment initiations

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListPaymentInitiationsAsync(
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    requestBody: new Dictionary<string, object>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`PageSize`	long	➖	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`	Dictionary<String, object>	➖	N/A

Response

V3ListPaymentInitiationsResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

DeletePaymentInitiation

Delete a payment initiation by ID

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.DeletePaymentInitiationAsync(paymentInitiationID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`PaymentInitiationID`	string	✔️	The payment initiation ID

Response

V3DeletePaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

GetPaymentInitiation

Get a payment initiation by ID

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.GetPaymentInitiationAsync(paymentInitiationID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`PaymentInitiationID`	string	✔️	The payment initiation ID

Response

Models.Requests.V3GetPaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

RetryPaymentInitiation

Retry a payment initiation

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.RetryPaymentInitiationAsync(paymentInitiationID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`PaymentInitiationID`	string	✔️	The payment initiation ID

Response

Models.Requests.V3RetryPaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ApprovePaymentInitiation

Approve a payment initiation

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ApprovePaymentInitiationAsync(paymentInitiationID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`PaymentInitiationID`	string	✔️	The payment initiation ID

Response

Models.Requests.V3ApprovePaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

RejectPaymentInitiation

Reject a payment initiation

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.RejectPaymentInitiationAsync(paymentInitiationID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`PaymentInitiationID`	string	✔️	The payment initiation ID

Response

V3RejectPaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ReversePaymentInitiation

Reverse a payment initiation

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ReversePaymentInitiationAsync(
    paymentInitiationID: "<id>",
    v3ReversePaymentInitiationRequest: new Models.Components.V3ReversePaymentInitiationRequest() {
        Reference = "<value>",
        Description = "than juicy slowly faint so yum seldom",
        Amount = 383763,
        Asset = "<value>",
    }
);

// handle response

Parameters

Parameter	Type	Required	Description
`PaymentInitiationID`	string	✔️	The payment initiation ID
`V3ReversePaymentInitiationRequest`	Models.Components.V3ReversePaymentInitiationRequest	➖	N/A

Response

Models.Requests.V3ReversePaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListPaymentInitiationAdjustments

List all payment initiation adjustments

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListPaymentInitiationAdjustmentsAsync(
    paymentInitiationID: "<id>",
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    requestBody: new Dictionary<string, object>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`PaymentInitiationID`	string	✔️	The payment initiation ID
`PageSize`	long	➖	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`	Dictionary<String, object>	➖	N/A

Response

V3ListPaymentInitiationAdjustmentsResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListPaymentInitiationRelatedPayments

List all payments related to a payment initiation

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListPaymentInitiationRelatedPaymentsAsync(
    paymentInitiationID: "<id>",
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    requestBody: new Dictionary<string, object>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`PaymentInitiationID`	string	✔️	The payment initiation ID
`PageSize`	long	➖	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`	Dictionary<String, object>	➖	N/A

Response

V3ListPaymentInitiationRelatedPaymentsResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

CreatePool

Create a formance pool object

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

V3CreatePoolRequest req = new V3CreatePoolRequest() {
    Name = "<value>",
    AccountIDs = new List<string>() {
        "<value>",
    },
};

var res = await sdk.Payments.V3.CreatePoolAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	V3CreatePoolRequest	✔️	The request object to use for the request.

Response

Models.Requests.V3CreatePoolResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

ListPools

List all pools

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.ListPoolsAsync(
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    requestBody: new Dictionary<string, object>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`PageSize`	long	➖	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`	Dictionary<String, object>	➖	N/A

Response

V3ListPoolsResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

GetPool

Get a pool by ID

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.GetPoolAsync(poolID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`PoolID`	string	✔️	The pool ID

Response

Models.Requests.V3GetPoolResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

DeletePool

Delete a pool by ID

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.DeletePoolAsync(poolID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`PoolID`	string	✔️	The pool ID

Response

V3DeletePoolResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

GetPoolBalances

Get pool balances

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;
using System;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.GetPoolBalancesAsync(
    poolID: "<id>",
    at: System.DateTime.Parse("2023-10-09T22:18:42.179Z")
);

// handle response

Parameters

Parameter	Type	Required	Description
`PoolID`	string	✔️	The pool ID
`At`	DateTime	➖	The time to filter by

Response

V3GetPoolBalancesResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

AddAccountToPool

Add an account to a pool

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.AddAccountToPoolAsync(
    poolID: "<id>",
    accountID: "<id>"
);

// handle response

Parameters

Parameter	Type	Required	Description
`PoolID`	string	✔️	The pool ID
`AccountID`	string	✔️	The account ID

Response

V3AddAccountToPoolResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

RemoveAccountFromPool

Remove an account from a pool

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.RemoveAccountFromPoolAsync(
    poolID: "<id>",
    accountID: "<id>"
);

// handle response

Parameters

Parameter	Type	Required	Description
`PoolID`	string	✔️	The pool ID
`AccountID`	string	✔️	The account ID

Response

V3RemoveAccountFromPoolResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

GetTask

Get a task and its result by ID

Example Usage

using FormanceSDK;
using FormanceSDK.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Payments.V3.GetTaskAsync(taskID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`TaskID`	string	✔️	The task ID

Response

Models.Requests.V3GetTaskResponse

Errors

Error Type	Status Code	Content Type
FormanceSDK.Models.Errors.V3ErrorResponse	default	application/json
FormanceSDK.Models.Errors.SDKException	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

V3

Overview

Available Operations

GetInfo

Example Usage

Response

Errors

CreateAccount

Example Usage

Parameters

Response

Errors

ListAccounts

Example Usage

Parameters

Response

Errors

GetAccount

Example Usage

Parameters

Response

Errors

GetAccountBalances

Example Usage

Parameters

Response

Errors

CreateBankAccount

Example Usage

Parameters

Response

Errors

ListBankAccounts

Example Usage

Parameters

Response

Errors

GetBankAccount

Example Usage

Parameters

Response

Errors

UpdateBankAccountMetadata

Example Usage

Parameters

Response

Errors

ForwardBankAccount

Example Usage

Parameters

Response

Errors

ListConnectors

Example Usage

Parameters

Response

Errors

InstallConnector

Example Usage

Parameters

Response

Errors

ListConnectorConfigs

Example Usage

Response

Errors

UninstallConnector

Example Usage

Parameters

Response

Errors

GetConnectorConfig

Example Usage

Parameters