Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simontreanor/funstripelite
A lightweight F# library to connect to the Stripe API
https://github.com/simontreanor/funstripelite
api automation banking fsharp payment-integration payment-provider payments stripe stripe-api
Last synced: about 1 month ago
JSON representation
A lightweight F# library to connect to the Stripe API
- Host: GitHub
- URL: https://github.com/simontreanor/funstripelite
- Owner: simontreanor
- Created: 2022-04-22T12:32:27.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T18:23:21.000Z (8 months ago)
- Last Synced: 2024-04-15T23:06:45.710Z (7 months ago)
- Topics: api, automation, banking, fsharp, payment-integration, payment-provider, payments, stripe, stripe-api
- Language: F#
- Homepage:
- Size: 16.5 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FunStripeLite
A lightweight F# library to connect to the Stripe API. Targets .NET Standard 2.0 and .NET Standard 2.1.
## Latest updates
2023-12-06: version 1.4.0 changes the target frameworks to .NET Standard 2.0 and .NET Standard 2.1 and updates FSharp.Core to version 8.0.100.
2023-11-13: version 1.3.3 makes some minor performance enhancements.
2023-10-13: version 1.3.2 provides a corrected serialise utility function.
2023-10-13: version 1.3.1 restores a small number of utility functions that are not required by the library but are very useful for serialising Stripe objects.
2023-10-13: version 1.3.0 fixes an issue with form serialisation that meant that JsonField names were only applied to the top level elements. It also tidies the code up a little.
2023-08-29: version 1.2.3 updates the Stripe API from version 2022-11-15 to 2023-08-16, which contains some breaking changes. See the [Stripe API changelog](https://stripe.com/docs/upgrades#api-changelog) for details.
2023-06-29: version 1.2.2 updates the package dependencies for FSharp.Core and FSharp.Data to 6.0.7 and 6.2.0 respectively.
2022-11-22: version 1.2.0 updates the Stripe API from version 2022-08-01 to 2022-11-15, which contains some breaking changes. See the [Stripe API changelog](https://stripe.com/docs/upgrades#api-changelog) for details. As .NET 5 is out-of-support, this has been removed from the target frameworks.
2022-10-05: version 1.1.0 updates the Stripe API from version 2020-08-27 to 2022-08-01, which contains some breaking changes. See the [Stripe API changelog](https://stripe.com/docs/upgrades#api-changelog) for details.
2022-04-22: FunStripeLite version 1.0.0 forked from FunStripe and stripped down
## Installation
Get the latest version from [Nuget](https://www.nuget.org/packages/FunStripeLite/)
## Usage
Open the StripeModel and StripeRequest modules.
Here's an example of how to create a new payment method:
```F#
let settings = RestApi.StripeApiSettings.New(apiKey = "")
let getNewPaymentMethod () =
asyncResult {
return!
PaymentMethods.CreateOptions.New(
card = Choice2Of2 (PaymentMethods.Create'CardTokenParams.New("tok_visa")),
type' = PaymentMethods.Create'Type.Card
)
|> PaymentMethods.Create settings
}
```
The result value is an `AsyncResult`, giving you the requested object in case of success or a detailed error response if not.
The general format of API requests is ``.`` `settings` `options`.
To instantiate the `settings` you need to pass in your Stripe API key. Having local rather than global settings allows you to use different keys for different Stripe accounts if you need to.
The `options` can be provided using record notation or if there are many uninitialised properties you can use the static `New` method to instantiate the record more effiently.
## References
[Stripe Documentation](https://stripe.com/docs)
[Developer Tools](https://stripe.com/docs/development)
[API Reference](https://stripe.com/docs/api)
[Official Stripe .NET Library](https://github.com/stripe/stripe-dotnet)
[Stripe OpenAPI Specification](https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.sdk.json)