Syntch Gateway API

GetContracts

Administration - Recurring Billing Contracts

**Requires Authentication**
Requires the role:	Merchant

The following routes are available for this service:
GET	/merchants/{merchantKey}/customers/{customerKey}/contracts/{contractKeys}	Get details for one or more contracts.

**GetContracts** Parameters:
Name	Parameter	Data Type	Required	Description
MerchantKey	path	integer	Yes	The key of the merchant.
CustomerKey	path	integer	Yes	The customer key.
ContractKeys	path	integer	Yes	A comma separated list of contract keys. Limit 10.

**ContractDetail** Parameters:
Name	Parameter	Data Type	Required
ContractKey	form	int	No
MerchantKey	form	int	No
CustomerKey	form	int	No
Token	form	string	No
BillAmount	form	decimal	No
StartDate	form	DateTime?	No
EndDate	form	DateTime?	No
MerchantContractName	form	string	No
MerchantContractId	form	string	No
BillingInterval	form	int?	No
BillingPeriod	form	string	No
ActivationStatus	form	string	No
MaxFailures	form	int?	No
FailureInterval	form	int?	No
FailurePeriod	form	string	No
EmailMerchant	form	bool	No
EmailCustomer	form	bool	No
EmailMerchantFailure	form	bool	No
EmailCustomerFailure	form	bool	No
TaxAmount	form	decimal	No
TotalAmount	form	decimal	No
MaxAmount	form	decimal?	No
CustomFields	form	List<ContractCustomField>	No
AmountBillsToDate	form	decimal	No
EmailCustomerReceiptOption	form	string	No
NextBillDate	form	DateTime?	No
NumberPayments	form	int?	No
NumberBillsToDate	form	int?	No
NumberFailures	form	int?	No

**ContractCustomField** Parameters:
Name	Parameter	Data Type	Required	Description
CustomValue	form	string	No
CustomKey	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /merchants/{merchantKey}/customers/{customerKey}/contracts/{contractKeys} HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContractDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Contracts.Responses">
  <ActivationStatus>String</ActivationStatus>
  <AmountBillsToDate>0</AmountBillsToDate>
  <BillAmount>0</BillAmount>
  <BillingInterval>0</BillingInterval>
  <BillingPeriod>String</BillingPeriod>
  <ContractKey>0</ContractKey>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Contracts.DTO">
    <d2p1:ContractCustomField>
      <d2p1:CustomKey>0</d2p1:CustomKey>
      <d2p1:CustomValue>String</d2p1:CustomValue>
    </d2p1:ContractCustomField>
  </CustomFields>
  <CustomerKey>0</CustomerKey>
  <EmailCustomer>false</EmailCustomer>
  <EmailCustomerFailure>false</EmailCustomerFailure>
  <EmailCustomerReceiptOption>String</EmailCustomerReceiptOption>
  <EmailMerchant>false</EmailMerchant>
  <EmailMerchantFailure>false</EmailMerchantFailure>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <FailureInterval>0</FailureInterval>
  <FailurePeriod>String</FailurePeriod>
  <MaxAmount>0</MaxAmount>
  <MaxFailures>0</MaxFailures>
  <MerchantContractId>String</MerchantContractId>
  <MerchantContractName>String</MerchantContractName>
  <MerchantKey>0</MerchantKey>
  <NextBillDate>0001-01-01T00:00:00</NextBillDate>
  <NumberBillsToDate>0</NumberBillsToDate>
  <NumberFailures>0</NumberFailures>
  <NumberPayments>0</NumberPayments>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <TaxAmount>0</TaxAmount>
  <Token>String</Token>
  <TotalAmount>0</TotalAmount>
</ContractDetail>