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

List cost contracts

Retrieve data for all cost contracts, either for a company or the specified merchant accounts.

Request parameters

To retrieve a list of cost contracts for a specific account key, make a POST /listCostContracts request specifying:

NameTypeRequiredDescription

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`

Response parameters

The response contains a cost contract list for the specified account key.

There needs to be at least one cost contract associated with the specified  accountKey for the response to return a populated  costContractDataSO object.

NameTypeReturned by defaultDescription

costContractDataSO

class
-white_check_mark-

A container for cost contract data.This field takes the following children:

  • billable
  • minimumAmount
  • minimumTxs
  • name
  • remark
  • startDate
  • stopDate 

billable

Boolean
-white_check_mark-

  • true: the cost contract is billable.

  • false: the cost contract is not billable.

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).

minimumTxs

int
-white_check_mark-

The minimum number of transactions per month.

name

String
-white_check_mark-

The name identifying the cost contract.

remark

String
-x-

Free text comment or remark about the cost contract.

startDate

String
-white_check_mark-

The start date when the cost contract becomes effective.

stopDate

String
-x-
The end date after which the cost contract is not effective any longer.
If not end date is returned, it means the contract is effective until one of the parties takes action to terminate it.

pspReference

String
-white_check_mark-

Adyen's 16-character unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.

Examples

Request

Response