Struct paypal_rs::Client

pub struct Client {
    pub client: Client,
    pub sandbox: bool,
    pub auth: Auth,
}

Represents a client used to interact with the paypal api.

Fields

client: Client

Internal http client

sandbox: bool

Whether you are or not in a sandbox enviroment.

auth: Auth

Api Auth information

Implementations

impl Client

pub async fn create_order<'_>(
    &'_ self,
    order: OrderPayload,
    header_params: HeaderParams
) -> Result<Order, Box<dyn Error>>

Creates an order. Supports orders with only one purchase unit.

pub async fn update_order<'_, S: Display>(
    &'_ self,
    id: S,
    intent: Option<Intent>,
    purchase_units: Option<Vec<PurchaseUnit>>
) -> Result<(), Box<dyn Error>>

Updates an order with the CREATED or APPROVED status. You cannot update an order with the COMPLETED status.

Only replacing the existing purchase units and intent is supported right now.

Note: You can only update the intent from Authorize to Capture

More info on what you can change: https://developer.paypal.com/docs/api/orders/v2/#orders_patch

pub async fn show_order_details<'_, S: Display>(
    &'_ self,
    order_id: S
) -> Result<Order, Box<dyn Error>>

Shows details for an order, by ID.

pub async fn capture_order<'_, S: Display>(
    &'_ self,
    order_id: S,
    header_params: HeaderParams
) -> Result<Order, Box<dyn Error>>

Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.

pub async fn authorize_order<'_, S: Display>(
    &'_ self,
    order_id: S,
    header_params: HeaderParams
) -> Result<Order, Box<dyn Error>>

Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.

impl Client

pub fn new<S: Into<String>>(client_id: S, secret: S, sandbox: bool) -> Client

Returns a new client, you must get_access_token afterwards to interact with the api.

Examples

let clientid = std::env::var("PAYPAL_CLIENTID").unwrap();
let secret = std::env::var("PAYPAL_SECRET").unwrap();

let mut client = paypal_rs::Client::new(
    clientid.as_str(),
    secret.as_str(),
    true,
);
client.get_access_token().await.unwrap();

pub async fn get_access_token<'_>(&'_ mut self) -> Result<(), Box<dyn Error>>

Gets a access token used in all the api calls.

pub fn access_token_expired(&self) -> bool

Checks if the access token expired.

Trait Implementations

impl Debug for Client

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.