Modules
Paypal is a payments platform that helps you accept payments and manage subscriptions in an easy way for your website or application.
PayPal requires an authenticated OAuth2 token to interact with the API. This module helps manage and retrieve tokens, ensuring the token is kept active and automatically refreshed in the background before expiry.
The access structure has the information for accessing to the rest of the requests and the information about the expiration of the token.
Performs OAuth2 authentication against PayPal to retrieve an access token.
The worker is performing the refresh of the token.
Builds the shared Req.Request used by all PayPal API modules
(Order, Payment, Subscription, Plan, Product).
Most of the currencies in the Paypal requests and responses are handled
as a JSON object that is including currency_code and value. But it's
even more complex in other requests.
When something goes wrong, Paypal is replying us with an error message and this is the struct for retrieving this kind of errors.
Each detail implemented for the error.
The link is accumulating all of the required information for handling the HATEOAS links.
The operation is the struct where we store the information for the operations performed in orders and payments. Most of the requests that are performing an action is returning an operation.
Ecto Helpers is a module that is ensuring we have the common functions in use for most of the schemas or modules that uses Ecto.
The orders is the element that let us to charge an amount to the clients.
Authorization is the information embebed into the
Paypal.Order.Authorized for getting all of the information for the
authorized payment.
Seller protection gives us information about if the protection of the seller is elegible and the categories for the disputes.
The authorized struct is the response performed by Paypal.Order.authorize/1
where we can see the status of the authorization and other information
related to the request.
Purchase Unit has the information for each detail line in the bought items.
The payment define the list of authorizations that are included inside of the authorized order.
Create an order. It contains the information for creating an order.
The experience context is the information needed for creating an order and provide information about how Paypal should behave when we go to its website for performing the payment.
Order information. The information retrieved from Paypal about the order.
Payer get all the information about who's paying the order.
The purchase unit is the information for each unit purchased (or to purchase) included in an order.
Represents a Capture object from the PayPal v2 PurchaseUnit API.
The item inside of each purchase unit.
See Paypal.Order.PurchaseUnit.
Represents a Payment Collection object from the PayPal v2 API.
The UPC EAN code.
Perform payment actions for PayPal. Payments are authorized orders or captures.
The returned information after performing a capture of an authorized order.
Authorized order information.
Payment refund information. The information retrieved from Paypal about the refund.
Request object that Refunds a captured payment, by ID. For a full refund,
include an empty request body. For a partial refund, include an amount
object in the request body.
Manage recurring billing subscriptions for PayPal.
Billing details and cycle execution information for a PayPal subscription.
Response returned after capturing an authorized payment on a subscription.
Schema and validation for creating a subscription in PayPal.
Subscription information retrieved from the PayPal Subscriptions API.
Manage billing plans for PayPal Subscriptions.
Represents a billing cycle inside a PayPal billing plan.
Schema and validation for creating a billing plan in PayPal.
Plan details retrieved from the PayPal Billing Plans API.
Plan list response returned from the PayPal Billing Plans API.
Payment preferences for a PayPal billing plan.
Tax details for a PayPal billing plan.
Manage catalog products for PayPal Subscriptions.
Schema and validation for creating a product in the PayPal Catalog Products API.
Product information retrieved from the PayPal Catalog Products API.
Product list response returned from the PayPal Catalog Products API.
Response returned after revising a PayPal subscription.
Subscriber details in a PayPal subscription.
Transaction item within a subscription's transaction list.
Transactions response returned for a PayPal subscription.