The official TrueLayer .NET client provides convenient access to TrueLayer APIs from applications built with .NET.
The library currently supports .NET Standard 2.1, .NET 5.0 and .NET 6.0.
Using the .NET Core command-line interface (CLI) tools:
dotnet add package TrueLayer.ClientUsing the NuGet Command Line Interface (CLI)
nuget install TrueLayer.ClientUsing the Package Manager Console:
Install-Package TrueLayer.ClientFrom within Visual Studio:
- Open the Solution Explorer.
- Right-click on a project within your solution.
- Click on Manage NuGet Packages...
- Click on the Browse tab and search for "TrueLayer".
- Click on the
TrueLayerpackage, select the appropriate version in the right-tab and click Install.
Pre-release packages can be downloaded from GitHub Packages.
dotnet add package TrueLayer.Client --prerelease --source https://nuget.pkg.github.com/TrueLayer/index.json
More information on using GitHub packages with .NET.
For a comprehensive list of examples, check out the API documentation.
First sign up for a developer account. Follow the instructions to set up a new application and obtain your Client ID and Secret. Once the application has been created you must add your application redirected URIs in order to test your integration end-to-end.
Next, generate a signing key pair used to sign API requests.
To generate a private key, run:
docker run --rm -v ${PWD}:/out -w /out -it alpine/openssl ecparam -genkey -name secp521r1 -noout -out ec512-private-key.pemTo obtain the public key, run:
docker run --rm -v ${PWD}:/out -w /out -it alpine/openssl ec -in ec512-private-key.pem -pubout -out ec512-public-key.pemNavigate to the Payments settings section of the TrueLayer console and upload your public key. Obtain the Key Id.
Add your Client ID, Secret and Signing Key ID to appsettings.json or any other supported configuration provider.
{
"TrueLayer": {
"ClientId": "your id",
"ClientSecret": "your secret",
"UseSandbox": true,
"Payments": {
"SigningKey": {
"KeyId": "85eeb2da-702c-4f4b-bf9a-e98af5fd47c3"
}
}
}
}Register the TrueLayer client in Startup.cs or Program.cs (.NET 6.0):
public IConfiguration Configuration { get; }
public void ConfigureServices(IServiceCollection services)
{
services.AddTrueLayer(configuration, options =>
{
if (options.Payments?.SigningKey != null)
{
// For demo purposes only. Private key should be stored securely
options.Payments.SigningKey.PrivateKey = File.ReadAllText("ec512-private-key.pem");
}
});
}Alternatively you can create a class that implements IConfigureOptions<TrueLayerOptions> if you have more complex configuration requirements.
Inject ITrueLayerClient into your classes:
public class MyService
{
private readonly ITrueLayerClient _client;
public MyService(ITrueLayerClient client)
{
_client = client;
}
public async Task<ActionResult> MakePayment()
{
var paymentRequest = new CreatePaymentRequest(
amountInMinor: amount.ToMinorCurrencyUnit(2),
currency: Currencies.GBP,
paymentMethod: new PaymentMethod.BankTransfer(
new Provider.UserSelected
{
Filter = new ProviderFilter
{
ProviderIds = new[] { "mock-payments-gb-redirect" }
}
},
new Beneficiary.ExternalAccount(
"TrueLayer",
"truelayer-dotnet",
new AccountIdentifier.SortCodeAccountNumber("567890", "12345678")
)
),
user: new PaymentUserRequest("Jane Doe", "jane.doe@example.com", "0123456789")
);
var apiResponse = await _client.Payments.CreatePayment(
paymentRequest,
idempotencyKey: Guid.NewGuid().ToString()
);
if (!apiResponse.IsSuccessful)
{
return HandleFailure(
apiResponse.StatusCode,
// Includes details of any errors
apiResponse.Problem
)
}
// Pass the ResourceToken to the TrueLayer Web or Mobile SDK
// or, redirect to the TrueLayer Hosted Payment Page
string hostedPaymentPageUrl = _client.Payments.CreateHostedPaymentPageLink(
apiResponse.Data!.Id,
apiResponse.Data!.ResourceToken,
new Uri("https://redirect.yourdomain.com"));
return Redirect(hostedPaymentPageUrl);
}
}For more examples see the API documentation. Advanced customization options and documentation for contributors can be found in the Wiki.
Inject ITrueLayerClient into your classes:
public class MyService
{
private readonly ITrueLayerClient _client;
public MyService(ITrueLayerClient client)
{
_client = client;
}
public async Task<ActionResult> GetProvider(string id)
{
var apiResponse = await _client.PaymentsProviders.GetPaymentsProvider(id);
if (!apiResponse.IsSuccessful)
{
return HandleFailure(
apiResponse.StatusCode,
// Includes details of any errors
apiResponse.Problem
)
}
return OkObjectResult(apiResponse.Data.Id);
}
}For more examples see the API documentation. Advanced customization options and documentation for contributors can be found in the Wiki.
Inject ITrueLayerClient into your classes:
public class MyService
{
private readonly ITrueLayerClient _client;
public MyService(ITrueLayerClient client)
{
_client = client;
}
public async Task<ActionResult> MakePayout()
{
var payoutRequest = new CreatePayoutRequest(
merchantAccountId: "VALID_MERCHANT_ID",
amountInMinor: amount.ToMinorCurrencyUnit(2),
currency: Currencies.GBP,
beneficiary: new Beneficiary.ExternalAccount(
"TrueLayer",
"truelayer-dotnet",
new SchemeIdentifier.Iban("VALID_IBAN")
)
);
var apiResponse = await _client.Payments.CreatePayout(
payoutRequest,
idempotencyKey: Guid.NewGuid().ToString()
);
if (!apiResponse.IsSuccessful)
{
return HandleFailure(
apiResponse.StatusCode,
// Includes details of any errors
apiResponse.Problem
)
}
return Accepted(apiResponse.Data.Id);
}
}For more examples see the API documentation. Advanced customization options and documentation for contributors can be found in the Wiki.
This project uses Cake to build, test and publish packages.
Run build.sh (Mac/Linux) or build.ps1 (Windows) To build and test the project.
This will output NuGet packages and coverage reports in the artifacts directory.
The library API documentation is built using DocFx. To build and serve the docs locally run:
./build.sh --target ServeDocs
This will serve the docs on http://localhost:8080.
Contributions are always welcome!
Please adhere to this project's code of conduct.