BillGoldService Web Service

BillGoldService

Click here for a complete list of operations.

AddUpdateRecurringOrder

עבודה עם מערכת הוראות קבע בענן.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Interface/BillGoldService.asmx HTTP/1.1
Host: secure.cardcom.solutions
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "BillGoldService/AddUpdateRecurringOrder"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddUpdateRecurringOrder xmlns="BillGoldService">
      <TerminalNumber>int</TerminalNumber>
      <UserName>string</UserName>
      <Password>string</Password>
      <RecurringOrder>
        <InternalUsageRowID>string</InternalUsageRowID>
        <Operation>string</Operation>
        <Account>
          <AccountId>int</AccountId>
          <CompanyName>string</CompanyName>
          <RegisteredBusinessNumber>string</RegisteredBusinessNumber>
          <ForeignAccountNumber>string</ForeignAccountNumber>
          <SiteUniqueId>string</SiteUniqueId>
          <FirstName>string</FirstName>
          <City>string</City>
          <Street1>string</Street1>
          <Street2>string</Street2>
          <ZipCode>string</ZipCode>
          <PoBox>string</PoBox>
          <PhLine>string</PhLine>
          <PhMobile>string</PhMobile>
          <PhFax>string</PhFax>
          <Email>string</Email>
          <VatFree>boolean</VatFree>
          <Comments>string</Comments>
          <InvoiceByMail>boolean</InvoiceByMail>
          <ContactName>string</ContactName>
          <IsDocumentLangEnglish>boolean</IsDocumentLangEnglish>
          <RecurringPaymentsActive>boolean</RecurringPaymentsActive>
          <DontCheckForDuplicate>boolean</DontCheckForDuplicate>
        </Account>
        <BankInfo>
          <Bank>int</Bank>
          <Branch>int</Branch>
          <AccountNumber>long</AccountNumber>
          <Description>string</Description>
        </BankInfo>
        <LowProfileDealGuid>guid</LowProfileDealGuid>
        <CreditCard>
          <Token>guid</Token>
          <Number>string</Number>
          <Month>short</Month>
          <Year>short</Year>
          <CardOwnerId>string</CardOwnerId>
          <Description>string</Description>
          <ApprovalNumber>string</ApprovalNumber>
          <CardOwnerName>string</CardOwnerName>
          <SkipIfHaveBankInfo>string</SkipIfHaveBankInfo>
        </CreditCard>
        <RecurringPayments>
          <ExtRecurringPayments>
            <RecurringId>int</RecurringId>
            <InternalDecription>string</InternalDecription>
            <NextDateToBill>dateTime</NextDateToBill>
            <TotalNumOfBills>int</TotalNumOfBills>
            <NumOfPaymentsAlreadyCharged>int</NumOfPaymentsAlreadyCharged>
            <IsActive>boolean</IsActive>
            <TimeIntervalId>short</TimeIntervalId>
            <FinalDebitCoinId>int</FinalDebitCoinId>
            <IsInvoiceCreate>boolean</IsInvoiceCreate>
            <Comments>string</Comments>
            <DocTypeToCreate>int</DocTypeToCreate>
            <IsPrintNumOfPayments>boolean</IsPrintNumOfPayments>
            <IsPrintBillMonth>boolean</IsPrintBillMonth>
            <DepartmentId>short</DepartmentId>
            <UserId>int</UserId>
            <IsByProducts>boolean</IsByProducts>
            <FlexItem xsi:nil="true" />
            <ProdList xsi:nil="true" />
            <ReturnValue>string</ReturnValue>
            <ChargeInTerminal>int</ChargeInTerminal>
          </ExtRecurringPayments>
          <ExtRecurringPayments>
            <RecurringId>int</RecurringId>
            <InternalDecription>string</InternalDecription>
            <NextDateToBill>dateTime</NextDateToBill>
            <TotalNumOfBills>int</TotalNumOfBills>
            <NumOfPaymentsAlreadyCharged>int</NumOfPaymentsAlreadyCharged>
            <IsActive>boolean</IsActive>
            <TimeIntervalId>short</TimeIntervalId>
            <FinalDebitCoinId>int</FinalDebitCoinId>
            <IsInvoiceCreate>boolean</IsInvoiceCreate>
            <Comments>string</Comments>
            <DocTypeToCreate>int</DocTypeToCreate>
            <IsPrintNumOfPayments>boolean</IsPrintNumOfPayments>
            <IsPrintBillMonth>boolean</IsPrintBillMonth>
            <DepartmentId>short</DepartmentId>
            <UserId>int</UserId>
            <IsByProducts>boolean</IsByProducts>
            <FlexItem xsi:nil="true" />
            <ProdList xsi:nil="true" />
            <ReturnValue>string</ReturnValue>
            <ChargeInTerminal>int</ChargeInTerminal>
          </ExtRecurringPayments>
        </RecurringPayments>
      </RecurringOrder>
    </AddUpdateRecurringOrder>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddUpdateRecurringOrderResponse xmlns="BillGoldService">
      <AddUpdateRecurringOrderResult>
        <InternalUsageRowID>string</InternalUsageRowID>
        <ResponseCode>int</ResponseCode>
        <Description>string</Description>
        <RecurringIds>
          <Recurring>
            <RecurringId>int</RecurringId>
            <ReturnValue>string</ReturnValue>
            <IsNewRecurring>boolean</IsNewRecurring>
          </Recurring>
          <Recurring>
            <RecurringId>int</RecurringId>
            <ReturnValue>string</ReturnValue>
            <IsNewRecurring>boolean</IsNewRecurring>
          </Recurring>
        </RecurringIds>
        <IsNewAccount>boolean</IsNewAccount>
        <AccountId>int</AccountId>
      </AddUpdateRecurringOrderResult>
    </AddUpdateRecurringOrderResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Interface/BillGoldService.asmx HTTP/1.1
Host: secure.cardcom.solutions
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AddUpdateRecurringOrder xmlns="BillGoldService">
      <TerminalNumber>int</TerminalNumber>
      <UserName>string</UserName>
      <Password>string</Password>
      <RecurringOrder>
        <InternalUsageRowID>string</InternalUsageRowID>
        <Operation>string</Operation>
        <Account>
          <AccountId>int</AccountId>
          <CompanyName>string</CompanyName>
          <RegisteredBusinessNumber>string</RegisteredBusinessNumber>
          <ForeignAccountNumber>string</ForeignAccountNumber>
          <SiteUniqueId>string</SiteUniqueId>
          <FirstName>string</FirstName>
          <City>string</City>
          <Street1>string</Street1>
          <Street2>string</Street2>
          <ZipCode>string</ZipCode>
          <PoBox>string</PoBox>
          <PhLine>string</PhLine>
          <PhMobile>string</PhMobile>
          <PhFax>string</PhFax>
          <Email>string</Email>
          <VatFree>boolean</VatFree>
          <Comments>string</Comments>
          <InvoiceByMail>boolean</InvoiceByMail>
          <ContactName>string</ContactName>
          <IsDocumentLangEnglish>boolean</IsDocumentLangEnglish>
          <RecurringPaymentsActive>boolean</RecurringPaymentsActive>
          <DontCheckForDuplicate>boolean</DontCheckForDuplicate>
        </Account>
        <BankInfo>
          <Bank>int</Bank>
          <Branch>int</Branch>
          <AccountNumber>long</AccountNumber>
          <Description>string</Description>
        </BankInfo>
        <LowProfileDealGuid>guid</LowProfileDealGuid>
        <CreditCard>
          <Token>guid</Token>
          <Number>string</Number>
          <Month>short</Month>
          <Year>short</Year>
          <CardOwnerId>string</CardOwnerId>
          <Description>string</Description>
          <ApprovalNumber>string</ApprovalNumber>
          <CardOwnerName>string</CardOwnerName>
          <SkipIfHaveBankInfo>string</SkipIfHaveBankInfo>
        </CreditCard>
        <RecurringPayments>
          <ExtRecurringPayments>
            <RecurringId>int</RecurringId>
            <InternalDecription>string</InternalDecription>
            <NextDateToBill>dateTime</NextDateToBill>
            <TotalNumOfBills>int</TotalNumOfBills>
            <NumOfPaymentsAlreadyCharged>int</NumOfPaymentsAlreadyCharged>
            <IsActive>boolean</IsActive>
            <TimeIntervalId>short</TimeIntervalId>
            <FinalDebitCoinId>int</FinalDebitCoinId>
            <IsInvoiceCreate>boolean</IsInvoiceCreate>
            <Comments>string</Comments>
            <DocTypeToCreate>int</DocTypeToCreate>
            <IsPrintNumOfPayments>boolean</IsPrintNumOfPayments>
            <IsPrintBillMonth>boolean</IsPrintBillMonth>
            <DepartmentId>short</DepartmentId>
            <UserId>int</UserId>
            <IsByProducts>boolean</IsByProducts>
            <FlexItem xsi:nil="true" />
            <ProdList xsi:nil="true" />
            <ReturnValue>string</ReturnValue>
            <ChargeInTerminal>int</ChargeInTerminal>
          </ExtRecurringPayments>
          <ExtRecurringPayments>
            <RecurringId>int</RecurringId>
            <InternalDecription>string</InternalDecription>
            <NextDateToBill>dateTime</NextDateToBill>
            <TotalNumOfBills>int</TotalNumOfBills>
            <NumOfPaymentsAlreadyCharged>int</NumOfPaymentsAlreadyCharged>
            <IsActive>boolean</IsActive>
            <TimeIntervalId>short</TimeIntervalId>
            <FinalDebitCoinId>int</FinalDebitCoinId>
            <IsInvoiceCreate>boolean</IsInvoiceCreate>
            <Comments>string</Comments>
            <DocTypeToCreate>int</DocTypeToCreate>
            <IsPrintNumOfPayments>boolean</IsPrintNumOfPayments>
            <IsPrintBillMonth>boolean</IsPrintBillMonth>
            <DepartmentId>short</DepartmentId>
            <UserId>int</UserId>
            <IsByProducts>boolean</IsByProducts>
            <FlexItem xsi:nil="true" />
            <ProdList xsi:nil="true" />
            <ReturnValue>string</ReturnValue>
            <ChargeInTerminal>int</ChargeInTerminal>
          </ExtRecurringPayments>
        </RecurringPayments>
      </RecurringOrder>
    </AddUpdateRecurringOrder>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AddUpdateRecurringOrderResponse xmlns="BillGoldService">
      <AddUpdateRecurringOrderResult>
        <InternalUsageRowID>string</InternalUsageRowID>
        <ResponseCode>int</ResponseCode>
        <Description>string</Description>
        <RecurringIds>
          <Recurring>
            <RecurringId>int</RecurringId>
            <ReturnValue>string</ReturnValue>
            <IsNewRecurring>boolean</IsNewRecurring>
          </Recurring>
          <Recurring>
            <RecurringId>int</RecurringId>
            <ReturnValue>string</ReturnValue>
            <IsNewRecurring>boolean</IsNewRecurring>
          </Recurring>
        </RecurringIds>
        <IsNewAccount>boolean</IsNewAccount>
        <AccountId>int</AccountId>
      </AddUpdateRecurringOrderResult>
    </AddUpdateRecurringOrderResponse>
  </soap12:Body>
</soap12:Envelope>