Afterpay Ruby

Based on the API docs

Afterpay Ruby is a Ruby wrapper for Afterpay API. It provides simple DSL and serialization to Afterpay's API attribute. This version supports the v2 version of Afterpay API.

Installation

Add this line to your application's Gemfile:

gem 'afterpay-sdk'

And then execute:

$ bundle

Or install it yourself as:

$ gem install afterpay-sdk

Usage

You need to configure Afterpay using your Merchant ID and secret.

For Rails, put this in your initializer.

Afterpay.configure do |config|
  config.app_id = <app_id>
  config.secret = <secret>

  # Sets the environment for Afterpay
  # defaults to sandbox
  # config.env = "sandbox" # "live"

  # Sets the user agent header for Afterpay requests
  # Refer https://developers.afterpay.com/afterpay-online/docs/user-agent-header-1
  # Refer https://developers.afterpay.com/afterpay-online/reference#user-agent-header
  # Example
  # config.afterpay_plugin = 'MyAfterpayModule/1.0.0'
  # config.platform = 'Rails/3.2.22.3'
  # config.system_information = 'RUBY/2.3.8'
  # config.merchant_website_url = <merchant_website_url>

  config.afterpay_plugin = <afterpay_plugin>
  config.platform = <platform>
  config.system_information = <system_information>
  config.merchant_website_url = <merchant_website_url>
  
end

Creating an Order

api docs

Order accepts a Consumer and an array of Item object which are required.

order = Afterpay::Order.create(
  total: <Money>,
  consumer: <Afterpay::Consumer>,
  items: [<Afterpay::Item>],
  success_url: <String>,
  cancel_url: <String>,
  merchant_reference: <String>,
  tax: <Money>,
  shipping: <Money | optional>,
  discounts: [<Afterpay::Discount | optional>],
  billing_address: <Afterpay::Address | optional>,
  shipping_address: <Afterpay::Address | optional>,
)

# OR

order = Afterpay::Order.new(
  ...
)
order.create


order.success?
=> true
order.token
=> xxxxxxx

# Error

order.success?
=> false
order.error
=> Afterpay::Error:0x00007f8a63953888
  @id="48da0bce49d39625",
  @code="invalid_object",
  @message="merchant.redirectConfirmUrl must be a valid URL, merchant.redirectConfirmUrl may not be empty" >

Executing Payment

payment = Afterpay::Payment.execute(
  token: token <String>,
  merchant_reference: "checkout-1" <String>
)
=> <Afterpay::Payment ...>

payment.success?
=> true
payment.order
=> <Afterpay::Order ...>
payment.status
=> APPROVED

Deferred Payment

mony = Money.from_amount(1000, "USD")

For Auth
Afterpay::Payment.execute_auth(request_id: 'fjfwwwjfj090292920', token: '002.v4krg5qpii1tbp0kvr261rf3p1k5jfe2fin', merchant_reference: '100101382')

For executing deferred payment
Afterpay::Payment.execute_deferred_payment(request_id: 'ppjjjkjk', merchant_reference: '100101382', amount: mony, payment_event_merchant_reference: '', order_id: 100101524323)

Void payment

Afterpay::Payment.execute_void(request_id: 'ppjjjkjk', order_id: 'same_as_id_of_auth_output', amount: mony)

Refund

Afterpay::Refund.execute(request_id: 'unique_id', order_id: 'order_id', amount: mony, merchant_reference: '100101382', refund_merchant_reference: '100101111')

Update Shipping Courier

Afterpay::Payment.update_shipping_courier(order_id: valid_order_id,
                                          shipped_at: DateTime.now.iso8601,
                                          name: "Bludart",
                                          tracking: "AWB129181",
                                          priority: "EXPRESS")

Get Payment By Order Id

This endpoint retrieves an individual payment along with its order details.

Afterpay::Payment.get_payment_by_order_id(order_id: valid_order_id)

Get Payment By Token

This endpoint retrieves an individual payment along with its order details.

Afterpay::Payment.get_payment_by_token(token: valid_token)

Update Payment by Order Id

This end point is for merchants that creates merchant side's order id after AfterPay order id creation. The merchants should call immediately after the AfterPay order is in order to properly update with their order id that can be tracked.

Afterpay::Payment.update_payment_by_order_id(order_id: valid_order_id,
merchant_reference: "new_merchant_order_id_1234")

reverse_payment_by_token

This endpoint performs a reversal of the checkout that is used to initiate the Afterpay payment process. This will cancel the order asynchronously as soon as it is created without the need of an additional call to the void endpoint. In order for a payment to be eligible, the order must be in an Auth-Approved or Captured state and must be issued within 10 minutes of the order being created. token paramater is the token of the checkout to be reversed (voided).

Afterpay::Payment.reverse_payment_by_token(token: valid_token)

list_payments

This endpoint retrieves a collection of payments along with their order details.

Afterpay::Payment.list_payments(
        to_created_date: nil,
        from_created_date: nil, limit: 10, offset: 0,
        tokens: [],
        ids: ["100101533036"], merchant_ref: ["100101382"],
        statuses: ["Approved"], order_by: "createdAt", asc: false
      )

Consumer Object

api docs

Consumer contains the details of the payee which will be serialized to API's format.

Afterpay::Consumer.new(
  email: <String>,
  phone: <String>,
  first_name: <String>,
  last_name: <String>,
)

Item Object

api docs

Item holds the details of purchace per item.

Afterpay::Item.new(
  name: <String>,
  price: <Money>,
  sku: <String | optional>,
  quantity: <Number | defaults to 1>,
  page_url: <String | optional>,
  image_url: <String | optional>,
  categories: [][],
  estimatedShipmentDate: <String | optional>
)

Discount Object

api docs

Discount Applied to the Order

Afterpay::Discount.new(
  name: <String>,
  amount: <Money>
)

Address Object

api docs

Item holds the details of purchace per item.

Afterpay::Address.new(
  name: <String>,
  line_1: <String>,
  line_2: <String | optional>,
  area_1: <String | required | Limited to 128 characters>,
  area_2: <String | optional | Limited to 128 characters>,
  region: <String | required | Limited to 128 characters>,
  postcode: <String | Number>,
  country: <String | optional>,
  phone: <String>
)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/YourMechanic/afterpay-sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

You will need to copy .env.sample to .env for running Afterpay console. This will not be checked into git.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Afterpay project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

afterpay-sdk

Development

Runtime

Afterpay Ruby

Installation

Usage

Creating an Order

Executing Payment

Deferred Payment

Void payment

Refund

Update Shipping Courier

Get Payment By Order Id

Get Payment By Token

Update Payment by Order Id

reverse_payment_by_token

list_payments

Consumer Object

Item Object

Discount Object

Address Object

Development

Contributing

License

Code of Conduct