No momento, esta página não está disponível em português
Default icon

Add cost contract

Create a new cost contract for an account key.

Request parameters

To add a new cost contract entry associated with an account key, make a POST /addCostContract request specifying:

NameTypeRequiredDescriptionNotes

accountKey

String

-white_check_mark-

Unique reference to identify an account.

  • Company account key format: Company.COMPANY_CODE
  • Merchant account key format: Merchant.MERCHANT_CODE

 

billable

Boolean

-x-
  • true: the cost contract is billable.
  • false: the cost contract is not billable.

If the specified account key refers to a merchant account, leave this field empty/do not assign a value to this field.

costContractName

String

-white_check_mark-

The name identifying the cost contract.
The specified name needs to be a valid one, i.e. it needs to be on the cost contract list assigned to the company or merchant.

 

minimumAmount

int
(Long)
-x-

The minimum chargeable amount per invoice.
The value is represented using the euro currency and minor units (i.e. 1000 = EUR 10).

If the specified account key refers to a merchant account, leave this field empty/do not assign a value to this field.

minimumTxs

int

-x-

The minimum number of transactions per month.

If the specified account key refers to a merchant account, leave this field empty/do not assign a value to this field.

remark

String

-x-

Free text comment or remark about the cost contract.

If the specified account key refers to a merchant account, leave this field empty/do not assign a value to this field.

startYear

int

-white_check_mark-

The starting year when the cost contract becomes effective.

Start date = startMonth + startYear
The starting date needs to be set not earlier than a month, and not later than two years in the future.

startMonth

int

-white_check_mark-

The starting month when the cost contract becomes effective.

Start date = startMonth + startYear
The starting date needs to be set not earlier than a month, and not later than two years in the future.

Response parameters

If there are no errors in the request, the call returns a pspReference.If any issues occur during the process, the call returns one or more warning or error messages.

NameTypeReturned by defaultDescription

pspReference

String

-white_check_mark-
A reference to uniquely identify the request.
Returned when the response is successful and a new contract is created.

warnings

Array

-x-

List containing one or more warning messages.
Returned when the request is not correctly processed.

errors

Array

-x-

List containing one or more error messages.
Returned when the request fails.

Examples

Request

Response

Response in case of an error