divido/divido-php

Divido PHP library

Thursday, June 28, 2018
by divido
Repository
3 Watchers
1 Stars
18,004 Installations

PHP
5 Dependents
0 Suggesters
4 Forks
2 Open issues
15 Versions
22 % Grown

The README.md

Divido API

This is the documentation for the Divido API., _(*1)

Current version: v1.15, _(*3)

Getting started

There are several distinct parts of a complete integration with the Divido API:, _(*4)

Deal Calculator
Finances
Credit Request
Finalize Credit Request
Activation
Cancellation
Refund
List all applications
Retrieve an application
Reporting / List all payment batches
Reporting / Retrieve records from a payment batch

Deal Calculator

Calculate APR, monthly repayments, duration etc, _(*5)

Finances

List Rate Card and all financial products available for a specific merchant., _(*6)

Credit Request

Create a new credit proposal and return an url to application form, _(*7)

Finalize Credit Request

Finalize an existing accepted credit application, will update the loan agreement and return an url to the contract signing., _(*8)

Activation

Activate whole or part of application, _(*9)

Cancellation

Cancel a deactivated application, _(*10)

Refund

Refund a part or whole of an activated application, _(*11)

List all applications

Returns a list of your applications. The applications are returned sorted by creation date, with the most recently created applications appearing first., _(*12)

Retrieve an application

Retrieves the details of an existing application. Supply the application ID and the API will return the corresponding application., _(*13)

Reporting / List all payment batches

Retrieves all payment batches., _(*14)

Reporting / Retrieve records from a payment batch

Retrieves the content of a payment batch. Supply the batch ID and the API will return all records., _(*15)

Change log

2018-14-03

Added a list of IP addresses to the webhook section (For production and Sandbox)

2017-11-03

Updated example response from Applications endpoint to include url and lenderLoanReference

2017-04-21

Added text element to address object, used for mergining one address line into flat, street, buildingNumber, buildingName.

2017-03-25

Added amount, products and reference to Cancellation Request. This allows partial cancellation of current unactivated amount

2017-03-13

Added shipping address to Credit Request

2016-12-20

Added Deal Calculator
Added directSign to Credit Request
Added Finalize Credit Request
Added activation status

2016-11-28

Added reference on activate and refund
Security enhancement: Added support for signing all api calls with a shared secret, contact Divido Support for more info.

2016-11-16

Added filter on proposal for List all applications
Updated the webhook response
Added reference in Credit Request

2016-11-07

Added product amount for refund and activation

2016-11-02

Added product lines for refund and activation

2016-11-01

Renamed fulfillment to activation
Added reporting

2016-10-30

Added refunds, fulfillments, fulfillmentStatus to respones

2016-10-18

Removed Deal Calculator
Added new statuses
Changed the product dataset
Updated the responses from the API

2016-09-27

Added partial fulfillment
Added refund
Added list all applications
Added retrieve an application
Added new statuses
Bug fixes

2016-06-28

Added cancellation method
Checkout URL
Bug fixes
Added more community libraries

2016-01-28

Added fulfillment method

2015-06-21

Added product to credit request
Campaigns changed to Finances

Offical Libraries

We strongly encourage use of our official libraries for accessing the Divido API. Our official libraries are listed below, as well as community supported libraries., _(*16)

PHP

Install from source, _(*17)

git clone https://github.com/DividoFinancialServices/divido-api-php.git, _(*18)

Community libraries

Please submit a pull request to this page to add any missing libraries that should be featured here. Please note that Divido does not offer any support for community libraries., _(*19)

Using the API

API endpoints

To use the Divido API to query data, you will need to send a request to the correct endpoint. Request endpoints should depend on whether you wish to query the live or sandbox environment:, _(*20)

Sandbox: https://secure.sandbox.divido.com/v1/
Live: https://secure.divido.com/v1/

HTTP response codes

You may encounter the following response codes. Any unsuccessful response codes will contain more information to help you identify the cause of the problem., _(*21)

200 The request has succeeded., _(*22)
201 The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field., _(*23)
404 Not Found. The requested resource was not found. The response body will explain which resource was not found., _(*24)
500 Internal Server Error. The server encountered an error while processing your request and failed. Please report this to the Divido support team., _(*25)

Webhooks

To alert you of any changes in the status of your resources, Divido provides webhooks. These are POST requests to your server that are sent as soon as a resource changes status. The body of the request contains details of the change., _(*26)

List of IP addresses

52.211.249.159 production, _(*27)

54.72.119.96 production, _(*28)

52.211.116.109 production, _(*29)

52.212.234.209 production, _(*30)

34.249.63.178 sandbox, _(*31)

Request

The API server will send a POST request to the response_url associated with the application or webhook_url set by Divido support team., _(*32)

Parameters

application Application ID, _(*33)

proposal Proposal ID, _(*34)

reference Third party reference (if supplied as part of the application), _(*35)

status New status, _(*36)

metadata Metadata (if supplied as part of the application), _(*37)

Example Request

JSON example, _(*38)

``` json { "application": "C84047A6D-89B2-FECF-D2B4-168444F5178C", "event": "application-status-update", "metadata": { "Invoice Number": "844001", "Order Number": "100019" }, "name": "John Doe", "proposal": "PAA717844-EE9D-78AF-D11C-EDCC1D180F87", "reference": "100019", "status": "ACCEPTED" }, _(*39)


Possible statuses
---------------

  - `PROPOSAL` - Proposal send to Underwriter, waiting for decision

  - `ACCEPTED` - Application accepted by Underwriter

  - `DECLINED` - Applicaiton declined by Underwriter

  - `REFERRED` - Application referred by Underwriter, waiting for new status

  - `INFO-NEEDED` - More information is required before decision

  - `ACTION-CUSTOMER` - Waiting for more information from Customer

  - `ACTION-RETAILER` - Waiting for more information from Merchant

  - `ACTION-LENDER` - Waiting for more information from Underwriter

  - `DEPOSIT-PAID` - Deposit paid by customer

  - `SIGNED` - Customer has signed all contracts

  - `READY` - Order is ready to be dispatched

  - `AWAITING-ACTIVATION` - Waiting for confirmation from Underwriter

  - `AWAITING-CANCELLATION` - Waiting for confirmation from Underwriter

  - `PARTIALLY-ACTIVATED` - Application partially activated by merchant

  - `ACTIVATED` - Application activated and confirmed by Underwriter

  - `CANCELLED` - Application cancelled

  - `REFUNDED` - Whole Application refunded

  - `COMPLETED` - Application completed (after cool down period)



Resources
===========

Finances
------------------

Returns an array with all finance options available for merchant

#### Example Request
   `GET` https://secure.divido.com/v1/finances?merchant={MERCHANT}&country={COUNTRY} `HTTP/1.1`

#### Example Response

JSON example

``` json
{
    "finances": [
        {
            "agreement_duration": 6,
            "country": "GB",
            "deferral_period": 0,
            "id": "F06895E17-EE96-926E-7137-37BCABB9DCF7",
            "instalment_fee": 0,
            "interest_rate": 0,
            "max_deposit": 50,
            "min_amount": 150,
            "min_deposit": 0,
            "setup_fee": 0,
            "text": "6 Month 0% Interest Free"
        },
        {
            "agreement_duration": 12,
            "country": "GB",
            "deferral_period": 0,
            "id": "F284D5F1D-E8AF-D4B7-E1AF-A352F6087352",
            "instalment_fee": 0,
            "interest_rate": 0,
            "max_deposit": 50,
            "min_amount": 150,
            "min_deposit": 0,
            "setup_fee": 0,
            "text": "12 Month 0% Interest Free"
        }
    ],
    "status": "ok"
}

Parameters

merchant - Your unique account identifier (Required, String), _(*40)

Example `live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102`

country - The country code (Optional, String), _(*41)

Example `GB`

Deal Calculator

The deal calculator calculates the payment terms for various terms and deposits., _(*42)

Example Request

GET https://secure.divido.com/v1/dealcalculator?merchant={MERCHANT}&amount={AMOUNT}&deposit={deposit}&country={country}&finance={FINANCE} HTTP/1.1, _(*43)

Example Response

JSON example, _(*44)

``` json { "status": 'ok', "purchase_price": 2000, "deposit_amount": 200, "credit_amount": 1800, "monthly_payment_amount": 150, "total_repayable_amount": 1800, "agreement_duration": 12, "interest_rate": 0.0, "interest_type": "APR" }, _(*45)


#### Parameters

`merchant`
    -  Your unique account identifier (*Required, String*)

Example live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102, _(*46)


`amount`
  - The total value of the order (*Required, Float*)

Example 2000.00, _(*47)


  `deposit` - The value of the deposit. (*Required, Float*)

Example 200, _(*48)


  `country` - The country code (*Required, String*)

Example GB, _(*49)


  `finance` - The finance code (*Required, String*)

Example FA48EC74D-D95D-73A9-EC99-004FBE14A027, _(*50)




Credit Request
------------------

The credit request creates a new proposal and return a URL to the Divido application form.

#### Example Request
   `POST` https://secure.divido.com/v1/creditrequest `HTTP/1.1`


``` javascript
curl https://secure.divido.com/v1/creditrequest \
-d merchant=live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102 \
-d deposit=100 \
-d finance=F06895E17-EE96-926E-7137-37BCABB9DCF7 \
-d directSign=true \
-d country=GB \
-d language=EN \
-d currency=GBP \
-d amount=1197.5 \
-d reference=100019 \
-d "customer[firstName]=John" \
-d "customer[middleNames]=L" \
-d "customer[lastName]=Doe" \
-d "customer[country]=GB" \
-d "customer[address][text]=115 High Street EC2A 4BX" \
-d "customer[address][postcode]=EC2A 4BX" \
-d "customer[address][street]=High street" \
-d "customer[address][flat]=B" \
-d "customer[address][buildingNumber]=115" \
-d "customer[address][buildingName]=Amanda apartments" \
-d "customer[address][town]=London" \
-d "customer[address][monthsAtAddress]=60" \
-d "customer[gender]=male" \
-d "customer[shippingAddress][postcode]=EC2A 4BX" \
-d "customer[shippingAddress][street]=High street" \
-d "customer[shippingAddress][flat]=B" \
-d "customer[shippingAddress][buildingNumber]=115" \
-d "customer[shippingAddress][buildingName]=Amanda apartments" \
-d "customer[shippingAddress][town]=London" \
-d "customer[email]=john.doe@domain.com" \
-d "customer[phoneNumber]=+44201234567" \
-d "customer[dateOfBirthYear]=1967" \
-d "customer[dateOfBirthMonth]=07" \
-d "customer[dateOfBirthDay]=01" \
-d "customer[bank][sortCode]=123456" \
-d "customer[bank][accountNumber]=12345678" \
-d "metadata[Invoice Number]=844001" \
-d "metadata[Order Number]=100019" \
-d "products[1][sku]=GIB100" \
-d "products[1][name]=Gibson Les Paul Studio Raw Guitar" \
-d "products[1][quantity]=1" \
-d "products[1][price]=1153.00" \
-d "products[1][vat]=20" \
-d "products[1][unit]=pcs" \
-d "products[1][image]=http://www.webshop.com/images/GIB100.png" \
-d "products[2][sku]=H10" \
-d "products[2][name]=Restring Upgrade" \
-d "products[2][quantity]=0.5" \
-d "products[2][price]=89" \
-d "products[2][vat]=20" \
-d "products[2][unit]=hour" \
-d "products[2][attributes]=1" \
-d "responseUrl=http://www.webshop.com/response.php" \
-d "checkoutUrl=http://www.webshop.com/checkout" \
-d "redirectUrl=http://www.webshop.com/success.html"

Example Response

JSON example, _(*51)

``` json { "id": "PD66DF728-5646-22E3-EF6F-CD3D2D094170", "status": "ok", "token": "bcaa33546495965c4c8b3dc41d8582a1", "url": "https://secure.divido.com/token/bcaa33546495965c4c8b3dc41d8582a1" }, _(*52)



#### Parameters

`merchant`
    -  Your unique account identifier (*Required, String*)
    -

Example live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102, _(*53)


`deposit` - The value of the deposit. (*Required, Float*)

Example 100, _(*54)


`finance` - The finance code (*Required, String*)

Example F23B150D4-9D00-724A-6DFA-A1E726F6761A, _(*55)


`directSign` - Whether or not to immediately go to signing after approval (*Optional, Boolean*, Default is `true`)

Example true, _(*56)



`country` - The country code (*Required, String*)

Example GB, _(*57)


`language` - The country code (*Required, String*)

Example EN, _(*58)


`currency` - The currency code (*Required, String*)

Example GBP, _(*59)


`amount` - Order total in same currency as proposal. Used to validate the total from product line items. (*Optional, Float*)

Example 1197.5, _(*60)


`reference` - Your intenral reference, will be returned in webhooks. (*Optional, Float*)

Example 100019, _(*61)


`customer['firstName']` - Customer first name (*Optional, String*)

Example Jane, _(*62)


`customer['middleNames']` - Customer middle names (*Optional, String*)

Example L, _(*63)


`customer['lastName']` - Customer last name (*Optional, String*)

Example Doe, _(*64)


`customer['country']` - Customer country (*Optional, String*)

Example GB, _(*65)


`customer['address']['text']` - Customer address in one line. We will try to match the address and split it up in street, flat, buildingNumber, buildingName. (*Optional, String*

Example 115 High street EC2A 4BX, _(*66)



`customer['address']['postcode']` - Customer postcode (*Optional, String*

Example EC2A 4BX, _(*67)


`customer['address']['street']` - Customer street (*Optional, String*)

Example High street, _(*68)


`customer['address']['flat']` - Customer flat (*Optional, String*)

Example B, _(*69)


`customer['address']['buildingNumber']` - Customer building number (*Optional, String*)

Example 115, _(*70)


`customer['address']['buildingName']` - Customer building name (*Optional, String*)

Example Amanda apartments, _(*71)


`customer['address']['town']` - Customer town (*Optional, String*)

Example London, _(*72)


`customer['address']['monthsAtAddress']` - Customer months at address (*Optional, String*)

Example 60, _(*73)


`customer['shippingAddress']['postcode']` - Customer postcode (*Optional, String*

Example EC2A 4BX, _(*74)


`customer['shippingAddress']['street']` - Customer street (*Optional, String*)

Example High street, _(*75)


`customer['shippingAddress']['flat']` - Customer flat (*Optional, String*)

Example B, _(*76)


`customer['shippingAddress']['buildingNumber']` - Customer building number (*Optional, String*)

Example 115, _(*77)


`customer['shippingAddress']['buildingName']` - Customer building name (*Optional, String*)

Example Amanda apartments, _(*78)


`customer['shippingAddress']['town']` - Customer town (*Optional, String*)

Example London, _(*79)


`customer['gender']` - Customer gender (*Optional, String*)

Example male, _(*80)


`customer['email']` - Customer email (*Optional, String*)

Example jane.doe@email.com, _(*81)


`customer['phoneNumber']` - Customer phone number (*Optional, String*)

Example 0201234567, _(*82)


`customer['dateOfBirthYear']` - Customer year of birth (*Optional, String*)

Example 1967, _(*83)


`customer['dateOfBirthMonth']` - Customer month of birth (*Optional, String*)

Example 07, _(*84)


`customer['dateOfBirthDay']` - Customer day of birth (*Optional, String*)

Example 01, _(*85)


`customer['bank']['sortCode']` - Customer bank sort code (*Optional, String*)

Example 123456, _(*86)


`customer['bank']['accountNumber']` - Customer bank account number (*Optional, String*)

Example 12345678, _(*87)


`metadata['key']` - metadata key (*Optional, String*)

Example Invoice Number, _(*88)


`metadata['value']` - metadata value (*Optional, String*)

Example 844001, _(*89)


`products['1']['sku']` - Product SKU (*Optional, String*)

Example GIB100, _(*90)


`products['1']['name']` - Product name/description (*Optional, String*)

Example Gibson Les Paul Studio Raw Guitar, _(*91)


`products['1']['quantity']` - Product quantity (*Optional, String*)

Example 1, _(*92)


`products['1']['price']` - Product price in same currency as proposal (*Optional, String*)

Example 1153.00, _(*93)

`products['1']['vat']` - Product VAT percentage (*Optional, String*)

Example 20, _(*94)


`products['1']['unit']` - Product unit (*Optional, String*)

Example pcs, _(*95)


`products['1']['image']` - Product image (*Optional, String*)

Example http://www.webshop.com/images/GIB100.png, _(*96)


`products['1']['attributes']` - Product attributes (1=Service fee,2=Shipping fee,3=Payment fee,6=Discount, 10=Price is without VAT, 20=Line item with order VAT sum) (*Optional, String*)

Example 1,2, _(*97)


`responseUrl` - The URL where we send notification about the payment (*Optional, String*)

Example http://www.webshop.com/response.php, _(*98)


`checkoutUrl` - A URL which Divido redirects the customer to if they get declined or wish to cancel their application (*Optional, String*)

Example http://www.webshop.com/checkout, _(*99)


`redirectUrl` - The URL the customer will get redirected to after a successful application (*Optional, String*)

Example http://www.webshop.com/success.html, _(*100)


Finalize Credit Request
------------------

Finalize an existing accepted credit application, will update the loan agreement and return an url to the contract signing. This only applies to Credit Requests created directSign = false.

#### Example Request
   `POST` https://secure.divido.com/v1/creditrequest/finalize `HTTP/1.1`


``` javascript
curl https://secure.divido.com/v1/creditrequest \
-d merchant=live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102 \
-d application=CAAC243AC-499A-84AF-DBBA-F58B9F7E798C \
-d deposit=100 \
-d finance=F06895E17-EE96-926E-7137-37BCABB9DCF7 \
-d amount=1197.5 \
-d "products[1][sku]=GIB100" \
-d "products[1][name]=Gibson Les Paul Studio Raw Guitar" \
-d "products[1][quantity]=1" \
-d "products[1][price]=1153.00" \
-d "products[1][vat]=20" \
-d "products[1][unit]=pcs" \
-d "products[1][image]=http://www.webshop.com/images/GIB100.png" \
-d "products[2][sku]=H10" \
-d "products[2][name]=Restring Upgrade" \
-d "products[2][quantity]=0.5" \
-d "products[2][price]=89" \
-d "products[2][vat]=20" \
-d "products[2][unit]=hour" \
-d "products[2][attributes]=1" \
-d "redirectUrl=http://www.webshop.com/success.html"

Example Response

JSON example, _(*101)

``` json { "id": "CAAC243AC-499A-84AF-DBBA-F58B9F7E798C", "status": "ok", "token": "bcaa33546495965c4c8b3dc41d8582a1", "url": "https://secure.divido.com/token/bcaa33546495965c4c8b3dc41d8582a1" }, _(*102)



Activation
------------------

Activate whole or part of an application and initialise a payout from the underwriter. Activate part of the application by specifing the products that should be activated. If no product data is submitted, the whole application will be activated.

#### Example Request
   `POST` https://secure.divido.com/v1/activation `HTTP/1.1`


``` javascript
curl https://secure.divido.com/v1/activation \
-d merchant="live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102" \
-d application="CAAC243AC-499A-84AF-DBBA-F58B9F7E798C" \
-d "products[1][sku]=GIB100" \
-d "products[1][name]=Gibson Les Paul Studio Raw Guitar" \
-d "products[1][quantity]=1" \
-d "products[1][price]=1153.00" \
-d "products[1][vat]=20" \
-d "products[2][sku]=H10" \
-d "products[2][name]=Restring Upgrade" \
-d "products[2][quantity]=0.5" \
-d "products[2][price]=89" \
-d "products[2][vat]=20" \
-d "products[2][attributes]=1" \
-d amount=1197.5 \
-d deliveryMethod="delivery" \
-d trackingNumber="DHL291824419F" \
-d reference="9482471" \
-d comment="Order was delivered to the customer by DHL" \

Example Response

JSON example, _(*103)

``` json { "result": { "creditAmount": 1097.5, "depositAmount": 100, "depositStatus": "PAID-BY-CARD", "activatedAmount": 1197.5, "activationStatus": "AWAITING-ACTIVATION", "activations": [ { "amount": 1197.5, "comment": "Order was delivered to the customer by DHL", "date": "2016-10-26 04:11", "deliveryMethod": "delivery", "reference": "9482471", "status": "AWAITING-ACTIVATION", "trackingNumber": "DHL291824419F" } ], "cancellations": [], "cancelledAmount": 0, "id": "C8A05742F-3040-44EC-C252-050FD8869F79", "lender": { "app": "Demo", "id": "L10F2BE8F-EF89-E403-E38F-8589ED2E51F5", "name": "Demo" }, "purchasePrice": 1197.5, "refundedAmount": 0, "refunds": [], "status": "AWAITING-ACTIVATION" }, "status": "ok" }, _(*104)



#### Parameters

`merchant` - Your unique account identifier (*Required, String*)

Example live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102, _(*105)


`application` - The application or proposal identifier. (*Required, String*)

Example CAAC243AC-499A-84AF-DBBA-F58B9F7E798C, _(*106)


`products['1']['sku']` - Product SKU (*Optional, String*)

Example GIB100, _(*107)


`products['1']['name']` - Product name/description (*Optional, String*)

Example Gibson Les Paul Studio Raw Guitar, _(*108)


`products['1']['quantity']` - Product quantity (*Optional, String*)

Example 1, _(*109)


`products['1']['price']` - Product price in same currency as proposal (*Optional, String*)

Example 1153.00, _(*110)

`products['1']['vat']` - Product VAT percentage (*Optional, String*)

Example 20, _(*111)


`amount` - Sum of the activated products (*Optional, String*)

Example 1197.5, _(*112)


`deliveryMethod` - How the goods were delivered, can be either "store" or "delivery" (*Required, String*)

Example delivery, _(*113)


`trackingNumber` - If the deliveryMethod is delivery and you have a tracking number (*Optional, String*)

Example DHL291824419F, _(*114)


`reference` - Your reference to identify the activation (*Optional, String*)

Example 9482471, _(*115)


`comment` - Comment to the underwriter, can be order number or other information (*Optional, String*)

Example Order was delivered to the customer by DHL, _(*116)


Cancellation
------------------

Mark an application as cancelled and notify the underwriter, only possible if application is DRAFT, REFERRED, INFO-NEEDED, ACTION-CUSTOMER, ACTION-RETAILER, ACTION-LENDER, ACCEPTED, DEPOSIT-PAID, PARTIALLY-ACTIVATED, SIGNED, READY.

#### Example Request
   `POST` https://secure.divido.com/v1/cancellation `HTTP/1.1`


``` javascript
curl https://secure.divido.com/v1/cancellation \
-d merchant="live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102" \
-d application="CAAC243AC-499A-84AF-DBBA-F58B9F7E798C" \
-d "products[1][sku]=H10" \
-d "products[1][name]=Restring Upgrade" \
-d "products[1][quantity]=0.5" \
-d "products[1][price]=89" \
-d "products[1][vat]=20" \
-d "products[1][attributes]=1" \
-d amount=44.5 \
-d reference="7321834" \
-d comment="Customer requested to cancelled the order"

Example Response

JSON example, _(*117)

``` json { "result": { "creditAmount": 1097.5, "depositAmount": 100, "depositStatus": "UNPAID", "activatedAmount": 0, "activationStatus": "AWAITING-ACTIVATION", "activations": [], "id": "CAAC243AC-499A-84AF-DBBA-F58B9F7E798C", "lender": { "app": "Demo", "id": "L10F2BE8F-EF89-E403-E38F-8589ED2E51F5", "name": "Demo" }, "purchasePrice": 1197.5, "refundedAmount": 0, "refunds": [], "cancelledAmount": 44.5, "cancellations": [ { "date": "2017-03-27 02:46", "amount": 44.5, "status": "PENDING", "reference": "ref: 1490582812", "comment": "" } ], "status": "AWAITING-CANCELLATION" }, "status": "ok" }, _(*118)



#### Parameters

`merchant` -  Your unique account identifier (*Required, String*)

Example live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102, _(*119)


`application` - The application or proposal identifier. (*Required, String*)

Example CAAC243AC-499A-84AF-DBBA-F58B9F7E798C, _(*120)


`products['1']['sku']` - Product SKU (*Optional, String*)

Example H10, _(*121)


`products['1']['name']` - Product name/description (*Optional, String*)

Example Restring Upgrade, _(*122)


`products['1']['quantity']` - Product quantity (*Optional, String*)

Example 1, _(*123)


`products['1']['price']` - Product price in same currency as proposal (*Optional, String*)

Example 89, _(*124)

`products['1']['vat']` - Product VAT percentage (*Optional, String*)

Example 20, _(*125)


`products['1']['attributes']` - Product attributes (1=Service,2=Shipping fee,3=Payment fee, 10=Price is without VAT) (*Optional, String*)

Example 1,2, _(*126)


`amount` - Sum of the refunded items (*Optional, String*)

Example 89, _(*127)


`reference` - Your reference to identify the refund (*Optional, String*)

Example 7321834, _(*128)


`comment` - Comment to the underwriter, can be order number or other information (*Optional, String*)

Example Customer requested to cancelled the order, _(*129)


Refund
------------------

Refund whole or part of an application, if the application is AWAITING-ACTIVATION, PARTIALLY-ACTIVATED, ACTIVATED or COMPLETED. For partial refund, specify the products that have been refunded. If no product data is submitted the whole application will be refunded.

#### Example Request
   `POST` https://secure.divido.com/v1/refund `HTTP/1.1`


``` javascript
curl https://secure.divido.com/v1/refund \
-d merchant="live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102" \
-d application="CAAC243AC-499A-84AF-DBBA-F58B9F7E798C" \
-d "products[1][sku]=H10" \
-d "products[1][name]=Restring Upgrade" \
-d "products[1][quantity]=0.5" \
-d "products[1][price]=89" \
-d "products[1][vat]=20" \
-d "products[1][attributes]=1" \
-d amount=44.5 \
-d reference="7321834" \
-d comment="Customer returned part of order"

Example Response

JSON example, _(*130)

``` json { "result": { "creditAmount": 1097.5, "depositAmount": 100, "depositStatus": "PAID-BY-CARD", "activatedAmount": 1197.5, "activationStatus": "AWAITING-ACTIVATION", "activations": [ { "amount": 1197.5, "comment": "Order was delivered to the customer by DHL", "date": "2016-10-26 04:11", "deliveryMethod": "delivery", "reference": "9482471", "status": "AWAITING-ACTIVATION", "trackingNumber": "DHL291824419F" } ], "cancellations": [], "cancelledAmount": 0, "id": "C8A05742F-3040-44EC-C252-050FD8869F79", "lender": { "app": "Demo", "id": "L10F2BE8F-EF89-E403-E38F-8589ED2E51F5", "name": "Demo" }, "purchasePrice": 1197.5, "refundedAmount": 44.5, "refunds": [ { "amount": 44.5, "comment": "Customer returned part of order", "date": "2016-10-26 04:14", "reference": "7321834", "status": "PENDING" } ], "status": "AWAITING-ACTIVATION" }, "status": "ok" }, _(*131)



#### Parameters

`merchant`     -  Your unique account identifier (*Required, String*)

Example live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102, _(*132)


`application` - The application or proposal identifier. (*Required, String*)

Example CAAC243AC-499A-84AF-DBBA-F58B9F7E798C, _(*133)


`products['1']['sku']` - Product SKU (*Optional, String*)

Example H10, _(*134)


`products['1']['name']` - Product name/description (*Optional, String*)

Example Restring Upgrade, _(*135)


`products['1']['quantity']` - Product quantity (*Optional, String*)

Example 0.5, _(*136)


`products['1']['price']` - Product price in same currency as proposal (*Optional, String*)

Example 89, _(*137)

`products['1']['vat']` - Product VAT percentage (*Optional, String*)

Example 20, _(*138)


`products['1']['attributes']` - Product attributes (1=Service,2=Shipping fee,3=Payment fee, 10=Price is without VAT) (*Optional, String*)

Example 1,2, _(*139)


`amount` - Sum of the refunded items (*Optional, String*)

Example 44.5, _(*140)


`reference` - Your reference to identify the refund (*Optional, String*)

Example 7321834, _(*141)


`comment` - Comment to the underwriter, can be order number or other information (*Optional, String*)

Example Customer returned part of order, _(*142)




List all applications
------------------

Returns a list of your applications. The applications are returned sorted by creation date, with the most recently created applications appearing first.

#### Example Request
   `GET` https://secure.divido.com/v1/applications?merchant={MERCHANT}&proposal={PROPOSAL}&status={STATUS}&page={PAGE} `HTTP/1.1`

#### Example Response

JSON example

``` json
{
    "itemsPerPage": 30,
    "page": 1,
    "records": [
        {
              "_activatableAmount": "£ 0",
            "_activatedAmount": "£ 1197.50",
            "_cancelableAmount": "£ 0",
            "_cancelledAmount": "£ 0",
            "_creditAmount": "£ 1197.50",
            "_currentCreditAmount": "£ 1197.50",
            "_depositAmount": "£ 0",
            "_monthlyPaymentAmount": "£ 199.58",
            "_purchasePrice": "£ 1197.50",
            "_refundableAmount": "£ 1197.50",
            "_refundedAmount": "£ 0",
            "_totalRepayableAmount": "£ 1197.48",
            "activatableAmount": 740,
            "activatedAmount": 1197.5,
            "activations": [
                {
                    "_amount": "£ 1197.50",
                    "amount": 1197.5,
                    "comment": "",
                    "date": "2016-10-26 04:20",
                    "deliveryMethod": "delivery",
                    "reference": "9482471",
                    "trackingNumber": ""
                }
            ],
            "agreementDuration": 6,
            "cancelableAmount": 0,
            "cancellations": [],
            "cancelledAmount": 0,
            "channel": {
                "id": "CDDB70595-BFE6-0B7D-EE5B-B09FFC89F98C",
                "name": "Webshop.com",
                "type": "webshop"
            },
            "country": "GB",
            "createdDate": "2016-10-26 04:18",
            "creditAmount": 1197.5,
            "currentCreditAmount": 1197.5,
            "currency": "GBP",
            "deferralPeriod": 0,
            "depositAmount": 0,
            "depositReference": "",
            "depositStatus": "NO-DEPOSIT",
            "directSign": true,
            "email": "john.doe@domain.com",
            "finance": {
                "id": "F06895E17-EE96-926E-7137-37BCABB9DCF7",
                "maxDeposit": 50,
                "minAmount": 150,
                "minDeposit": 0,
                "text": "6 Month 0% Interest Free"
            },
            "firstName": "John",
            "history": [
                {
                    "date": "2016-10-26 04:20",
                    "status": "AWAITING-ACTIVATION",
                    "text": "",
                    "type": "status",
                    "user": "James Weston"
                },
                {
                    "date": "2016-10-26 04:18",
                    "status": "SIGNED",
                    "text": "",
                    "type": "status",
                    "user": ""
                },
                {
                    "date": "2016-10-26 04:18",
                    "status": "ACCEPTED",
                    "text": "",
                    "type": "status",
                    "user": ""
                },
                {
                    "date": "2016-10-26 04:18",
                    "status": "",
                    "text": "Customer entered gateway from 10.11.12.1",
                    "type": "",
                    "user": ""
                }
            ],
            "id": "C92F7C65B-5C2D-6544-BB13-3E54243B9875",
            "identityVerified": false,
            "interestRate": 0,
            "interestType": "simple",
            "lastName": "Doe",
            "lender": "Demo",
            "lenderLoanReference": "XY111111",
            "lenderReference": "x22acc2e-2dc4-2ec2-3a7f-x4c5f02a0c3a",
            "metadata": {
                "Invoice Number": "844001",
                "Order Number": "100019"
            },
            "modifiedDate": "2016-10-26 04:20",
            "monthlyPaymentAmount": 199.58,
            "products": [
                {
                    "_price": "£ 1153",
                    "_sum": "£ 1153",
                    "image": "http://www.webshop.com/images/GIB100.png",
                    "name": "Gibson Les Paul Studio Raw Guitar",
                    "price": "1153.00",
                    "quantity": 1,
                    "sku": "GIB100",
                    "sum": "1153.00",
                    "unit": "pcs"
                },
                {
                    "_price": "£ 89",
                    "_sum": "£ 44.50",
                    "image": "",
                    "name": "Restring Upgrade",
                    "price": "89.00",
                    "quantity": 0.5,
                    "sku": "H10",
                    "sum": "44.50",
                    "unit": "hour"
                }
            ],
            "proposal": "PD56030F0-845C-ECF1-6118-0B26EFDCB273",
            "proposalCreator": null,
            "purchasePrice": 1197.5,
            "reference": "test reference",
            "refundableAmount": 1197.50,
            "refundedAmount": 0,
            "refunds": [],
            "status": "AWAITING-ACTIVATION",
            "totalRepayableAmount": 1197.5,
            "url": "https:\/\/secure.divido.com\/token\/0685cx87225604f0b75f53c6b6afe71x"
        },
        {
            ...
        },
        {
            ...
        },
        {
            ...
        }
    ],
    "status": "ok",
    "totalItems": 4
}

Parameters

merchant - Your unique account identifier (Required, String), _(*143)

Example `live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102`

country - Filter by country code (Optional, String), _(*144)

Example `GB`

status - Filter by status (Optional, String), _(*145)

Example `SIGNED`

proposal - Filter by proposal (Optional, String), _(*146)

Example `PAA717844-EE9D-78AF-D11C-EDCC1D180F87`

page - Show page, default 1 (Optional, String), _(*147)

Example `2`

Retrieve an application

Retrieves the details of an existing application. Supply the application ID and the API will return the corresponding application., _(*148)

Example Request

GET https://secure.divido.com/v1/applications?merchant={MERCHANT}&id={id} HTTP/1.1, _(*149)

Example Response

JSON example, _(*150)

``` json { "record": { "_activatableAmount": "£ 0", "_activatedAmount": "£ 1197.50", "_cancelableAmount": "£ 0", "_cancelledAmount": "£ 0", "_creditAmount": "£ 1197.50", "_currentCreditAmount": "£ 1197.50", "_depositAmount": "£ 0", "_monthlyPaymentAmount": "£ 199.58", "_purchasePrice": "£ 1197.50", "_refundableAmount": "£ 1197.50", "_refundedAmount": "£ 0", "_totalRepayableAmount": "£ 1197.48", "activatableAmount": 740, "activatedAmount": 1197.5, "activations": [ { "_amount": "£ 1197.50", "amount": 1197.5, "comment": "", "date": "2016-10-26 04:20", "deliveryMethod": "delivery", "reference": "9482471", "trackingNumber": "" } ], "agreementDuration": 6, "cancelableAmount": 0, "cancellations": [], "cancelledAmount": 0, "channel": { "id": "CDDB70595-BFE6-0B7D-EE5B-B09FFC89F98C", "name": "Webshop.com", "type": "webshop" }, "country": "GB", "createdDate": "2016-10-26 04:18", "creditAmount": 1197.5, "currentCreditAmount": 1197.5, "currency": "GBP", "deferralPeriod": 0, "depositAmount": 0, "depositReference": "", "depositStatus": "NO-DEPOSIT", "directSign": true, "email": "john.doe@domain.com", "finance": { "id": "F06895E17-EE96-926E-7137-37BCABB9DCF7", "maxDeposit": 50, "minAmount": 150, "minDeposit": 0, "text": "6 Month 0% Interest Free" }, "firstName": "John", "history": [ { "date": "2016-10-26 04:20", "status": "AWAITING-ACTIVATION", "text": "", "type": "status", "user": "James Weston" }, { "date": "2016-10-26 04:18", "status": "SIGNED", "text": "", "type": "status", "user": "" }, { "date": "2016-10-26 04:18", "status": "ACCEPTED", "text": "", "type": "status", "user": "" }, { "date": "2016-10-26 04:18", "status": "", "text": "Customer entered gateway from 10.11.12.1", "type": "", "user": "" } ], "id": "C92F7C65B-5C2D-6544-BB13-3E54243B9875", "identityVerified": false, "interestRate": 0, "interestType": "simple", "lastName": "Doe", "lender": "Demo", "lenderLoanReference": "XY111111", "lenderReference": "", "metadata": { "Invoice Number": "844001", "Order Number": "100019" }, "modifiedDate": "2016-10-26 04:20", "monthlyPaymentAmount": 199.58, "products": [ { "_price": "£ 1153", "_sum": "£ 1153", "image": "http://www.webshop.com/images/GIB100.png", "name": "Gibson Les Paul Studio Raw Guitar", "price": "1153.00", "quantity": 1, "sku": "GIB100", "sum": "1153.00", "unit": "pcs" }, { "_price": "£ 89", "_sum": "£ 44.50", "image": "", "name": "Restring Upgrade", "price": "89.00", "quantity": 0.5, "sku": "H10", "sum": "44.50", "unit": "hour" } ], "proposal": "PD56030F0-845C-ECF1-6118-0B26EFDCB273", "proposalCreator": null, "purchasePrice": 1197.5, "reference": "test reference", "refundableAmount": 1197.50, "refundedAmount": 0, "refunds": [], "status": "AWAITING-ACTIVATION", "totalRepayableAmount": 1197.5, "url": "https:\/\/secure.divido.com\/token\/0685cx87225604f0b75f53c6b6afe71x" }, "status": "ok" }, _(*151)



#### Parameters

`merchant`
    -  Your unique account identifier (*Required, String*)

Example live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102, _(*152)


`id` - Application id (*Required, String*)

Example C84047A6D-89B2-FECF-D2B4-168444F5178C, _(*153)


Reporting / List all payment batches
------------------

Retrieves all payment batches.

#### Example Request
   `GET` https://secure.divido.com/v1/payments?merchant={MERCHANT}&currency={CURRENCY}&lender={LENDER}&page={PAGE} `HTTP/1.1`

#### Example Response

JSON example

``` json
{
    "itemsPerPage": 30,
    "page": 1,
    "records": [
        {
            "currency": "GBP",
            "date": "2016-04-14",
            "id": "PB0506EBA-870B-FFC2-FCAB-250D1B1291BD",
            "lender": {
                "id": "L07F46CDF-5296-D190-1F2D-A1B5FD869B72",
                "name": "Demo"
            },
            "merchant": {
                "id": "M7470B82C-B1EE-158F-D965-CFFD3158992A",
                "name": "Sofa & Table"
            },
            "records": 1,
            "totalCreditAmount": 989,
            "totalNetPayment": 1074.165,
            "totalSubsidyAmount": 4.945
        },
        ...,
        ...
    ],
    "status": "ok",
    "totalItems": 3
}

Parameters

merchant - Your unique account identifier (Required, String), _(*154)

Example `live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102`

currency - Filter by currency code (Optional, String), _(*155)

Example `GBP`

lender - Filter by lender ID (Optional, String), _(*156)

Example `L07F46CDF-5296-D190-1F2D-A1B5FD869B72 `

page - Show page, default 1 (Optional, String), _(*157)

Example `2`

Reporting / Retrieve records from a payment batch

Retrieves the content of a payment batch. Supply the batch ID and the API will return all records., _(*158)

Example Request

GET https://secure.divido.com/v1/payments?merchant={MERCHANT}&id={id} HTTP/1.1, _(*159)

Example Response

JSON example, _(*160)

``` json { "record": { "currency": "GBP", "date": "2016-04-14", "id": "PB0506EBA-870B-FFC2-FCAB-250D1B1291BD", "lender": { "id": "L07F46CDF-5296-D190-1F2D-A1B5FD869B72", "name": "Demo" }, "totalCreditAmount": 989, "totalNetPayment": 1074.165, "totalSubsidyAmount": 4.945, "transactions": [ { "application": "CDD6CCE0C-8DC5-6EB4-9A08-45520484EB19", "creditAmount": 989, "customer": "HESELDEN, ANN", "depositAmount": 100, "finance": { "id": "F927FA596-6C9C-8376-A99B-70AE9A020F6B", "text": "0% 12 month - Demo Bank" }, "netPaymentAmount": 1074.165, "purchasePrice": 1089, "reference": "267381", "subsidyAmount": 4.945 } ] }, "status": "ok" }, _(*161)



#### Parameters

`merchant`
    -  Your unique account identifier (*Required, String*)

Example live_c31be25be.fb2ee4bc8a66e1ecd797c56f03621102, _(*162)


`id` - Batch id (*Required, String*)

Example PB0506EBA-870B-FFC2-FCAB-250D1B1291BD ```, _(*163)

The Versions

28/06 2018

dev-fix/test-testing

dev-fix/test-testing https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

05/06 2018

dev-master

9999999-dev https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

21/01 2018

dev-v1.15-stable

dev-v1.15-stable https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

21/01 2018

v1.15-stable

1.15.0.0 https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

06/12 2017

dev-feature/add_condition_for_docker_env

dev-feature/add_condition_for_docker_env https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

03/11 2017

dev-fix/add-missing-fields-to-doc

dev-fix/add-missing-fields-to-doc https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

22/12 2016

v1.9-stable

1.9.0.0 https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

29/11 2016

v1.8.1-stable

1.8.1.0 https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

16/11 2016

v1.8-stable

1.8.0.0 https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

10/11 2016

v1.7-stable

1.7.0.0 https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

10/11 2016

dev-refund

dev-refund https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

28/06 2016

v1.2-stable

1.2.0.0 https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

28/06 2016

v1.1.2-stable

1.1.2.0 https://www.divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

15/02 2016

v1.1.1-stable

1.1.1.0 https://divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

15/02 2016

v1.1

1.1.0.0 https://divido.com/

Divido PHP library

Sources Download

MIT

The Requires

php >=5.2.0
ext-curl *

api finance payment processing divido instalments

library divido-php

Divido PHP library

divido/divido-php

The README.md

Divido API

Getting started

Deal Calculator

Finances

Credit Request

Finalize Credit Request

Activation

Cancellation

Refund

List all applications

Retrieve an application

Reporting / List all payment batches

Reporting / Retrieve records from a payment batch

Change log

2018-14-03

2017-11-03

2017-04-21

2017-03-25

2017-03-13

2016-12-20

2016-11-28

2016-11-16

2016-11-07

2016-11-02

2016-11-01

2016-10-30

2016-10-18

2016-09-27

2016-06-28

2016-01-28

2015-06-21

Offical Libraries

PHP

Community libraries

Magento 1.*

Magento 2

WooCommerce

OpenCart

Using the API

API endpoints

HTTP response codes

Webhooks

List of IP addresses

Request

Parameters

Example Request

Parameters

Deal Calculator

Example Request

Example Response

Example Response

Example Response

Example Response

Example Response

Example Response

Parameters

Retrieve an application

Example Request

Example Response

Parameters

Reporting / Retrieve records from a payment batch

Example Request

Example Response

The Versions

dev-fix/test-testing

The Requires

dev-master

The Requires

dev-v1.15-stable

The Requires

v1.15-stable

The Requires

dev-feature/add_condition_for_docker_env

The Requires

dev-fix/add-missing-fields-to-doc

The Requires