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

Add cost contracts

Create a new cost contract for multiple account keys.

The /addCostContracts endpoint works like addCostContract, the only difference being the ability to create contracts for multiple account keys.

 Request parameters

To add new cost contract entries for multiple account keys, make a POST /addCostContracts request specifying:

NameTypeRequiredDescriptionNotes

accountKeys

List
-white_check_mark-

A list holding account key value stringsEach string in the list holds an account key value.Account key: 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 a new contract is created for the specified account keys in the accountKeys list.

warnings

String
-x-
List containing one or more warning messages about one or more cost contract creations with problems.
Returned when the new contract creation for the specified account keys in the accountKeys list does not work as expected.

errors

String
-x-

List containing one or more error messages about one or more failed cost contract creations.
Returned when the new contract creation for the specified account keys in the accountKeys list fails.

Examples

Request

Response

 Response in case of an error