Polarex.Payments (Polarex v0.3.0)
View SourceProvides API endpoints related to payments
Summary
Functions
@spec payments_get(id :: String.t(), opts :: keyword()) :: {:ok, Polarex.CardPayment.t() | Polarex.GenericPayment.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Get Payment
Get a payment by ID.
Scopes: payments:read
@spec payments_list(opts :: keyword()) :: {:ok, Polarex.ListResourcePayment.t()} | {:error, Polarex.HTTPValidationError.t()}
List Payments
List payments.
Scopes: payments:read
Options
organization_id: Filter by organization ID.checkout_id: Filter by checkout ID.order_id: Filter by order ID.status: Filter by payment status.method: Filter by payment method.customer_email: Filter by customer email.page: Page number, defaults to 1.limit: Size of a page, defaults to 10. Maximum is 100.sorting: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign-before the criteria name to sort by descending order.