BrightofficeAPI

Click here for a complete list of operations.

CreateCreditCardDetails

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 /Webservices/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/CreateCreditCardDetails"

<?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>
    <CreateCreditCardDetails xmlns="http://tempuri.org/">
      <CreditCardDetails>
        <CustomerCode>string</CustomerCode>
        <ThirdPartyCompany>string</ThirdPartyCompany>
        <CreditCardNumber>string</CreditCardNumber>
        <CardSecurityCode>string</CardSecurityCode>
        <GenerateToken>string</GenerateToken>
        <CardholderPresent>boolean</CardholderPresent>
        <AuthenticateCardholder>boolean</AuthenticateCardholder>
        <CardholderName>string</CardholderName>
        <CardExpiryDate>string</CardExpiryDate>
        <BillingAddress>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <PostCode>string</PostCode>
          <Country>string</Country>
        </BillingAddress>
        <HomePhone>string</HomePhone>
        <MobilePhone>string</MobilePhone>
        <Email>string</Email>
        <Source>string</Source>
        <SourceApplication>string</SourceApplication>
        <SourceTransactionRef>string</SourceTransactionRef>
        <SourceRef>string</SourceRef>
        <SourceCardHolderRef>string</SourceCardHolderRef>
      </CreditCardDetails>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </CreateCreditCardDetails>
  </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>
    <CreateCreditCardDetailsResponse xmlns="http://tempuri.org/">
      <CreateCreditCardDetailsResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </CreateCreditCardDetailsResult>
    </CreateCreditCardDetailsResponse>
  </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 /Webservices/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
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>
    <CreateCreditCardDetails xmlns="http://tempuri.org/">
      <CreditCardDetails>
        <CustomerCode>string</CustomerCode>
        <ThirdPartyCompany>string</ThirdPartyCompany>
        <CreditCardNumber>string</CreditCardNumber>
        <CardSecurityCode>string</CardSecurityCode>
        <GenerateToken>string</GenerateToken>
        <CardholderPresent>boolean</CardholderPresent>
        <AuthenticateCardholder>boolean</AuthenticateCardholder>
        <CardholderName>string</CardholderName>
        <CardExpiryDate>string</CardExpiryDate>
        <BillingAddress>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <PostCode>string</PostCode>
          <Country>string</Country>
        </BillingAddress>
        <HomePhone>string</HomePhone>
        <MobilePhone>string</MobilePhone>
        <Email>string</Email>
        <Source>string</Source>
        <SourceApplication>string</SourceApplication>
        <SourceTransactionRef>string</SourceTransactionRef>
        <SourceRef>string</SourceRef>
        <SourceCardHolderRef>string</SourceCardHolderRef>
      </CreditCardDetails>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </CreateCreditCardDetails>
  </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>
    <CreateCreditCardDetailsResponse xmlns="http://tempuri.org/">
      <CreateCreditCardDetailsResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </CreateCreditCardDetailsResult>
    </CreateCreditCardDetailsResponse>
  </soap12:Body>
</soap12:Envelope>