paypal-rs/README.md

83 lines
2.2 KiB
Markdown
Raw Normal View History

2020-06-10 14:46:05 +00:00
# paypal-rs
[![Crates.io](https://meritbadge.herokuapp.com/paypal-rs)](https://crates.io/crates/paypal-rs)
2020-06-09 08:08:22 +00:00
![Rust](https://github.com/edg-l/paypal-rs/workflows/Rust/badge.svg)
2020-06-09 16:23:46 +00:00
![Docs](https://docs.rs/paypal-rs/badge.svg)
2020-06-08 20:30:45 +00:00
2021-01-05 12:40:36 +00:00
A rust library that wraps the [paypal api](https://developer.paypal.com/docs/api) asynchronously in a stringly typed manner.
2020-06-08 20:30:45 +00:00
2020-06-09 16:27:51 +00:00
Crate: https://crates.io/crates/paypal-rs
2020-06-09 13:04:14 +00:00
Documentation: https://docs.rs/paypal-rs
2020-06-09 16:26:31 +00:00
Currently in early development.
2021-01-05 12:40:36 +00:00
Note: This README shows how to use the prerelease version, to view the README for `0.1.0` go [here](https://github.com/edg-l/paypal-rs/tree/0.1.0).
2020-06-10 11:03:18 +00:00
## Example
```rust
use paypal_rs::{
Client,
HeaderParams,
Prefer,
2021-01-05 12:40:36 +00:00
orders::{OrderPayload, Intent, PurchaseUnit, Amount},
common::Currency,
2020-06-10 11:03:18 +00:00
};
#[tokio::main]
async fn main() {
let clientid = std::env::var("PAYPAL_CLIENTID").unwrap();
let secret = std::env::var("PAYPAL_SECRET").unwrap();
2020-08-12 08:34:59 +00:00
let mut client = Client::new(clientid, secret, true);
2020-06-10 11:03:18 +00:00
client.get_access_token().await.unwrap();
let order_payload = OrderPayload::new(
Intent::Authorize,
vec![PurchaseUnit::new(Amount::new(
2021-01-05 12:40:36 +00:00
Currency::EUR, "10.0",
2020-06-10 11:03:18 +00:00
))],
);
let order = client
.create_order(
order_payload,
HeaderParams {
prefer: Some(Prefer::Representation),
..Default::default()
},
)
.await
.unwrap();
}
```
2020-06-09 16:26:31 +00:00
## Testing
You need the enviroment variables PAYPAL_CLIENTID and PAYPAL_SECRET to be set.
2020-06-10 11:03:18 +00:00
`cargo test --lib`
2020-06-10 14:44:00 +00:00
## Roadmap
2020-06-10 11:03:18 +00:00
2020-06-10 14:44:00 +00:00
- [x] Orders API - 0.1.0
2020-06-10 11:19:27 +00:00
- - [x] Create order
- - [x] Update order
- - [x] Show order details
- - [x] Authorize payment for order
- - [x] Capture payment for order
2020-06-10 14:44:00 +00:00
- [ ] Invoicing API - 0.2.0
- [ ] Payments API - 0.3.0
- [ ] Tracking API - 0.4.0
- [ ] Subscriptions API - 0.5.0
- [ ] Identity API - 0.6.0
- [ ] Disputes API - 0.7.0
- [ ] Catalog Products API - 0.8.0
- [ ] Partner Referrals API - 0.9.0
- [ ] Payouts API - 0.10.0
- [ ] Transaction Search API - 0.11.0
- [ ] Referenced Payouts API - 0.12.0
- [ ] Vault API - 0.13.0
- [ ] Webhooks Management API - 0.14.0
2021-01-05 12:40:36 +00:00
- [ ] Payment Experience Web Profiles API - 1.0.0