Create a Landlord contract for the given draft. Only one contract can be created for each draft.

Request

POST https://qover-sandbox.apigee.net/{country}/home/landlord/drafts/{draftId}/contract

Path parameters

Parameter name Value Description Additional
country string

The country ISO code case insensitive Country code in ISO 3166-1 alpha-2 The currently countries for which a line of business is available are:

  • BE
Required
draftId string

The Draft unique Id

Required

Request headers

Parameter name Value Description Additional
Qover-Api-Version string

The version of the api. Currently only '1.0' is available.

Required

Request body

The request body takes a complete Contract Payload resource, containing the following writable properties:

{
    "transaction": {
        "amount": "integer",
        "currency": "string",
        "payload": {},
        "type": "string"
    },
    "userTermsToken": "string",
    "variant": "string"
}

Properties

Name Type Description Additional
transaction object

Transaction description

transaction.amount integer

The amount value multiplied by 100. 13.25 will be represented by the integer 1325.

transaction.currency string

ISO 4217 currency code. The only currenlty supported currency is EUR.

Possible values are:

  • EUR
transaction.payload object

Empty object

transaction.type string

Payment method

Possible values are:

  • CREDITLINE
userTermsToken string

The user terms token showing the user terms have been retreived

variant string

The label that identifies the variant of the product.

Possible values are:

  • BASIC
  • CLASSIC
  • PREMIUM
Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Ok: Operation Successful

Headers returned

Name Type Description
Last-Modified date-time
contract status
400 Bad Request

Bad Request: The requested operation cannot be perfomed as the request is badly formatted or failed validation.

ValidationError
401 Unauthorized

Unauthorized: The authentication failed or is missing

403 Forbidden

Forbidden: You do not have the right to perform this operation

404 Not Found

Not Found: The requested ressource cannot be found

500 Internal Server Error

Internal Server error: The request could not processed due to a server error

General Error

Explore this API

country

The country ISO code case insensitive Country code in ISO 3166-1 alpha-2 The currently countries for which a line of business is available are:

  • BE
draftId

The Draft unique Id

body
Request Content-Type
Qover-Api-Version

The version of the api. Currently only '1.0' is available.

Response Content-Type
Try it out!