PayItMonthly Simple Integration

PayItMonthly enables your business to offer your customer finance.

This guide shows you how to embed our simple integration within your website.

Support

If you need to contact us for any reason you can email us at support@payitmonthly.uk or call us on 0333 212 3914.

Document History

v1.0.0 (30/05/2017)

  1. First integration launched

Getting Started

You need to have opened a live account at PayItMonthly. Once your account is live you can request your API key by emailing support@payitmonthly.uk.

HTML Form Based Application

<form action="https://payitmonthly.uk/simple-integration/" method="post"> 
    <input type="hidden" name="identification_key" value="adfwt2894ahgBUDSFOHE8we9"/>
    <input type="hidden" name="identification_version" value="1.0.0"/>
    <input type="hidden" name="goods_description" value="Photos - CD - Gold Package"/> 
    <input type="hidden" name="goods_price" value="60000"/> 
    <input type="hidden" name="finance_deposit_total" value="6000"/> 
    <input type="hidden" name="test_or_live" value="test"/>
    <input type="hidden" name="finance_max_duration" value="10"/>
    <input type="hidden" name="finance_first_payment_date" value="20170720"/>
    <input type="submit" value="PayItMonthly"/> 
</form>

Parameters

Name Description Required Type Validation
identification_key Public API key Yes string  
identification_version Integration version number Yes string  
test_or_live This specifies which mode to operate the system in Yes string test’ or ‘live’
goods_description Description of the goods/service that the customer is purchasing. This will be shown on the customers agreement Yes string  
goods_price Price of the goods/service that the customer is purchasing in pence before the deposit is taken. The value of finance required is calculated automatically (goods_price - finance_deposit_total) Yes int Positive integer between 1200 and 1000000
finance_deposit_total Total deposit paid/to be paid by the customer in pence. This is not collected by PayItMonthly and if you are not on our standard/basic product the deposit must be at least 10% of the goods_price. If you need PayItMonthly to collect the deposit as part of the process contact us Yes int Positive integer between 0 and 1000000
finance_number_of_instalments Number of instalments that the customer will pay - do not include the deposit as an instalment No int Between 1-12
finance_max_duration Maximum number of instalments/months that the customer can choose if you want it to be less than 12. This value is not used if the number of instalments is set No int Between 1-12
finance_first_payment_date The date of the first repayment that the customer will make. If this isn’t set the customer will be able to choose the date that works best for them. Each subsequent instalment will be taken on the same date each month No ISO 8601 Minimum of 7 and maximum of 60 days in the future
customer_title Customers title No string Either ‘Mr.’, ‘Mrs.’, ‘Miss.’, ‘Ms.’ or ‘Dr.’
customer_firstname Customers firstname No string  
customer_middle_name Customers middle name No string  
customer_surname Customers surname No string  
customer_mobile Customers mobile number No string  
customer_landline Customers landline No string  
customer_email Customers email address No string  
customer_address_line_1 House Number/Name No string  
customer_address_line_2 Street Address No string  
customer_address_line_3 Town No string  
customer_address_line_4 County No string  
customer_address_postcode Postcode No string  

Test Bank Details

Please use the following bank details when completeing an agreement in test mode.

Sort Code Account Number
20-00-00 55779911

Notifications

Once the customer has entered into the agreement you will receive an email to the address associated with your account with a link so that you can see the details that have been provided.


©2017 PayItMonthly