Skip to content

Latest commit

 

History

History
123 lines (81 loc) · 3.22 KB

5_charges.md

File metadata and controls

123 lines (81 loc) · 3.22 KB
Raw

Charges

Pay allows you to make one-time charges to a customer.

Creating a Charge

To charge a customer, you need to assign a payment method token before you can charge them.

@user.payment_processor.payment_method_token = params[:payment_method_token]
@user.payment_processor.charge(15_00) # $15.00 USD

The charge method takes the amount in cents as the primary argument.

You may pass optional arguments that will be directly passed on to the payment processor. For example, you can use these options to charge different currencies:

@user.payment_processor.charge(15_00, currency: "cad")

On failure, a Pay::Error will be raised with details about the payment failure.

Paddle Classic Charges

When creating charges with Paddle, they need to be approved by the customer. This is done by passing the Paddle Transaction ID to a Paddle.js checkout.

To see the required fields, see the Paddle API docs.

The amount can be set to 0 as this will be set by the Price set on Paddle, so will be ignored.

@user.payment_processor.charge(0, {
  items: [
    {
      quantity: 1,
      price_id: "pri_abc123"
    }
  ],
  # include additional fields here
})

Then you can set the transactionId attribute for Paddle.js. For more info, see the Paddle.js docs

Paddle Classic Charges

Paddle Classic requires an active subscription on the customer in order to create a one-time charge. It also requires a charge_name for the charge.

@user.payment_processor.charge(1500, {charge_name: "Test"}) # $15.00 USD
Lemon Squeezy Charges

Lemon Squeezy currently doesn't support one-time charges.

Retrieving Charges

To see a list of charges for a customer, you can access them with:

@user.payment_processor.charges

Refunding A Charge

You can refund a charge by calling refund! on the charge:

charge = @user.payment_processor.charges.last

# Refund the full amount
charge.refund!

# Partial refund of $5.00
charge.refund!(5_00)

Payment Method

Charges record a copy of their payment method. This allows users to update their payment methods without losing the information on previous purchases.

The details saved will vary depending upon the payment method used.

@charge.payment_method_type
#=> card, paypal, sepa, ideal, etc

@charge.brand
#=> Visa, Discover, MasterCard, American Express, PayPal, Venmo, etc

@charge.last4 #=> 4242
@charge.exp_month #=> 12
@charge.exp_year #=> 2021
@charge.email #=> PayPal email
@charge.username #=> Venmo username
@charge.bank #=> Bank name

Receipt URL

Paddle Classic and Stripe provide a receipt URL for each payment.

@charge.paddle_receipt_url
@charge.stripe_receipt_url

Paddle Receipts

Paddle Billing doesn't provide a receipt URL like Paddle Classic did.

In order to retrieve a PDF invoice for a transaction, an API request is required. This will return a URL to the PDF invoice. This URL is not permanent and will expire after a short period of time.

Paddle::Transaction.invoice(id: @charge.processor_id)

Next

See Subscriptions