AfterPay via Json for WooCommerce

General information

AfterPay via Json for WooCommerce is a plugin that extends WooCommerce, allowing you to take payments via AfterPay’s new RESTful Json API. With this extension you get access to AfterPay’s three payment methods – Invoice, Part Payment and Account.

  • At the moment AfterPay for WooCommerce is only available in Sweden. Norway will be added shortly.
  • You need an agreement with AfterPay to be able to use this plugin.

Required WooCommerce settings

Make sure that you have enabled pretty permalinks in your WordPress installation. Otherwise callbacks from AfterPay back to your store won’t work and orders will not be updated with the correct order status/information.

Configuration: Invoice payment

  • Go to: WooCommerce > Settings > Checkout > AfterPay Invoice.
  • Enable AfterPay Invoice by checking the Enable AfterPay Invoice checkbox.
  • The Title and Description fields controls what the customer sees during checkout.
  • Enter your AfterPay X-Auth-Key for the country that you have an agreement with AfterPay to sell to (currently only Sweden).
  • Invoice Fee – Enter the product ID of your Invoice Fee product. More information about this can be found in the Invoice Fee Handling section below.
  • Customer type – select if you want to sell to companies, persons or both customer types.
  • Separate shipping address – Check this box if you want to offer the possibility for companies to enter a separate shipping address. Contact AfterPay before enabling this feature.
  • Enable Order Management – check this box to enable AfterPay order capture on WooCommerce order completion and AfterPay order cancellation on WooCommerce order cancellation.
    This setting is used for all three payment methods.
  • AfterPay testmode – check this box if you have a test account and want to make purchases against AfterPay’s test server environment.
  • Debug Log – check this box to log events for debugging. The log can be found by navigating to > WooCommerce > System Status > Logs.

Invoice Fee Handling

The invoice Fee for AfterPay Invoice is added as a simple (hidden) product. To create a Invoice fee product:

  1. Add a simple (hidden) product. Mark it as a taxable product. For more information on how to add a simple (hidden) product please check WooCommerce documentation page on Adding and Managing products.
  2. Go to the AfterPay Invoice settings page and add the product ID (not the price or the SKU) of the Invoice Fee product. The ID can be found by hovering the Invoice Fee product on the Products page in WooCommerce.

Configuration: Part Payment

  • Go to: WooCommerce > Settings > Checkout > AfterPay Part Payment.
  • Enable AfterPay Part Payment by checking the Enable AfterPay Part Payment checkbox.
  • The Title and Description fields controls what the customer sees during checkout.
  • Enter your AfterPay X-Auth-Key for the country that you have an agreement with AfterPay to sell to (currently only Sweden).
  • Customer type – select if you want to sell to companies, persons or both customer types.
  • Separate shipping address – Check this box if you want to offer the possibility for companies to enter a separate shipping address. Contact AfterPay before enabling this feature.
  • AfterPay testmode – check this box if you have a test account and want to make purchases against AfterPay’s test server environment.
  • Debug Log – check this box to log events for debugging. The log can be found by navigating to > WooCommerce > System Status > Logs.

Configuration: Account

  • Go to: WooCommerce > Settings > Checkout > AfterPay Account.
  • Enable AfterPay Account by checking the Enable AfterPay Account checkbox.
  • The Title and Description fields controls what the customer sees during checkout.
  • Enter your AfterPay X-Auth-Key for the country that you have an agreement with AfterPay to sell to (currently only Sweden).
  • Customer type – select if you want to sell to companies, persons or both customer types.
  • Separate shipping address – Check this box if you want to offer the possibility for companies to enter a separate shipping address. Contact AfterPay before enabling this feature.
  • AfterPay testmode – check this box if you have a test account and want to make purchases against AfterPay’s test server environment.
  • Debug Log – check this box to log events for debugging. The log can be found by navigating to > WooCommerce > System Status > Logs.

Order management

When an order is created in WooCommerce and a reservation number exists in AfterPay’s system, you have the possibility to handle the order management in AfterPay directly from WooCommerce. This way you can save time and don’t have to work in both systems simultaneously.

Note that as long as the order only is a reservation in AfterPay’s system you can’t actually view the invoice in their backoffice. First after activating the reservation (and by that also sending the invoice) you’re able to view it in AfterPays backoffice. If you have any questions about this, please contact AfterPay directly.

Requirements

To get started with order management in AfterPay via your WooCommerce store, you need to check the Enable Order Management checkbox.

Cancel an order

  1. The WooCommerce order status need to be set as Processing.
  2. Go to the order edit screen by navigate to → WooCommerceOrders and click on the order you want to edit.
  3. In the Order details box there is a selectbox named Order status. Change the status to Cancelled.
  4. Click the Save Order button located at the top right on the screen.
  5. If everything was successful a new order note is created saying AfterPay reservation was successfully cancelled.

Capture an order

  1. The WooCommerce order status need to be set as Processing.
  2. Go to the order edit screen by navigate to → WooCommerceOrders and click on the order you want to edit.
  3. In the Order details box there is a selectbox named Order status. Change the status to Completed.
  4. Click the Save Order button located at the top right on the screen.
  5. If everything was successful a new order note is created saying AfterPay reservation was successfully captured, invoice number: nnnnn. The invoice is now sent to the customer from AfterPay.

The module does not support partial captures.

Update an order

At the moment changes made in an order in WooCommerce is not updated in AfterPay’s system. If you need to change an order either cancel the order and let the customer create a new order or get in touch with AfterPay so they can help you with changes in the order.

Refund an order

  1. The WooCommerce order status need to be set as Completed.
  2. Go to the order edit screen by navigate to → WooCommerceOrders and click on the order you want to edit.
  3. In the Order items box, press the Refund button.
  4. To make a full refund for the entire order, enter the Order total amount in the Refund amount text field.
  5. Press the Refund via AfterPay button.
  6. If everything was successful a new order note is created saying AfterPay refund was successfully processed.

The module does not support partial refunds.