Concepts
A few words are used throughout this documentation with particular meaning…
Supplier
Usually, you are the supplier.
- A supplier offers products to their trade customers using iwocaPay,
- Each transaction to is tied to a supplier,
- Each supplier has a unique identifier, authentication token and handle.
Trade customer
A trade customer is a supplier‘s customer.
- A trade customer purchases goods from a supplier.
- A trade customer pays for their goods via iwocaPay.
pay link
Each transaction is tied to a single pay link.
- pay links often take the form of a redirect URL which take customers to the iwocaPay Checkout and can be pasted or embedded where ever you take payments.
- Each pay link has a unique identifier.
- You can manually generate pay link in your iwocaPay dashboard.
Types of Pay Link
Universal
The Universal pay link is usually the best option for simply integrating the iwocaPay checkout.
The link consists of your supplier handle and two optional query parameters. These parameters determine which fields are pre-filled for the user on the Checkout page.
For example, the following URL would generate a pay link with the amount set to £300.00 and the reference test:
https://www.iwoca.co.uk/pay/me/supplier_handle/?amount=300&reference=testCustom
The Custom pay link is a one-time pay link with a fixed amount and reference.
By default, Custom pay links inherit your Universal pay link pricing. However, this can be changed during creation.
The link consists of your supplier handle and the Custom pay link unique identifier.
https://www.iwoca.co.uk/pay/to/supplier_handle/pay_link_uuid/Package
The Package pay link is a re-usable pay link with a fixed amount and reference.
By default, Package pay link inherit your Universal pay link pricing. However, this can be changed during creation.
The link consists of your supplier handle and the Package pay link unique identifier.
https://www.iwoca.co.uk/pay/me/supplier_handle/package/pay_link_package_uuid/Checkout
The iwocaPay checkout gives your trade customers the option to:
- Pay Now and settle the full amount via an instant bank transfer, or
- Pay Later and split the payment into either three or twelve equal monthly instalments.
Regardless of what they choose, you’ll have the funds in your account as soon as they finish the checkout process.
Order
Every Checkout has an associated Order.
- If you require modifications to details within the Checkout process, for example, price changes, you must create a new order.
- An Order should be considered the source of truth for your request.
Pricing structure
When creating a Custom or Package pay link, you can set its individual pricing structure in the iwocaPay dashboard.
To adjust the pricing of your Universal pay link, go to the Manage Account page in the iwocaPay dashboard.
For Plugins, update the pricing of your Universal pay link to modify the pricing structure.
- If a customer chooses to Pay Now, the transaction is always free for both you and your customer.
- If a customer chooses to Pay Later, there are two pricing options available: free for you and free for your customers.
Pricing options
Your customers are charged interest for the time they use to pay. You don’t pay a penny.
Your customers can spread the cost for free. you pay a fixed % of the total invoice value for any invoices settled with Pay Later.
iwocaPay dashboard
Your iwocaPay dashboard is where you can create and manage your pay links.
