Search

Are you looking for test card numbers?

Would you like to contact support?

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:

Name Type Required Description
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.

Name Type Returned by default Description
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 = 10 EUR).
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

{  
   "accountKey":"MerchantAccount.TestMerchant"
}
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <listCostContracts xmlns="http://caaccount.services.adyen.com">
      <request>
        <accountKey>MerchantAccount.TestMerchant</accountKey>
      </request>
    </listCostContracts>
  </soapenv:Body>
</soapenv:Envelope>

Response

{  
   "pspReference":"9914526948880159",
   "costContractData":[  
      {  
         "CostContractDataSO":{  
            "billable":"true",
            "minimumTxs":1000,
            "name":"merchantDemoContract",
            "startDate":"2008-01-01T00:00:00+01:00"
         }
      }
   ]
}
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://serviceobjects.caaccount.services.adyen.com" xmlns:ns0="http://caaccount.services.adyen.com">    <soap:Body>
        <ns0:listCostContractsResponse>
            <ns0:response>
                <ns0:pspReference>9914140635430144</ns0:pspReference>
                <ns0:costContractData>
                    <ns0:CostContractDataSO>
                        <ns1:billable>true</ns1:billable>
                        <ns1:minimumTxs>1000</ns1:minimumTxs>
                        <ns1:name>merchantDemoContract</ns1:name>
                        <ns1:startDate>2008-01-01T00:00:00+01:00</ns1:startDate>
                    </ns0:CostContractDataSO>
                </ns0:costContractData>
            </ns0:response>
        </ns0:listCostContractsResponse>
    </soap:Body>
</soap:Envelope>