BrightofficeAPI

Click here for a complete list of operations.

CreateTakePayment

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/CreateTakePayment"

<?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>
    <CreateTakePayment xmlns="http://tempuri.org/">
      <pRequest>
        <Code>string</Code>
        <InvoiceCode>string</InvoiceCode>
        <CardNumber>string</CardNumber>
        <CardHolderName>string</CardHolderName>
        <ValidFromMonth>string</ValidFromMonth>
        <ValidFromYear>string</ValidFromYear>
        <ExpiryMonth>string</ExpiryMonth>
        <ExpiryYear>string</ExpiryYear>
        <CardType>string</CardType>
        <CardCV2>string</CardCV2>
        <BillingAddress1>string</BillingAddress1>
        <BillingPostCode>string</BillingPostCode>
        <PaymentAmount>double</PaymentAmount>
        <PaymentMode>string</PaymentMode>
      </pRequest>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </CreateTakePayment>
  </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>
    <CreateTakePaymentResponse xmlns="http://tempuri.org/">
      <CreateTakePaymentResult>
        <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>
      </CreateTakePaymentResult>
    </CreateTakePaymentResponse>
  </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>
    <CreateTakePayment xmlns="http://tempuri.org/">
      <pRequest>
        <Code>string</Code>
        <InvoiceCode>string</InvoiceCode>
        <CardNumber>string</CardNumber>
        <CardHolderName>string</CardHolderName>
        <ValidFromMonth>string</ValidFromMonth>
        <ValidFromYear>string</ValidFromYear>
        <ExpiryMonth>string</ExpiryMonth>
        <ExpiryYear>string</ExpiryYear>
        <CardType>string</CardType>
        <CardCV2>string</CardCV2>
        <BillingAddress1>string</BillingAddress1>
        <BillingPostCode>string</BillingPostCode>
        <PaymentAmount>double</PaymentAmount>
        <PaymentMode>string</PaymentMode>
      </pRequest>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </CreateTakePayment>
  </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>
    <CreateTakePaymentResponse xmlns="http://tempuri.org/">
      <CreateTakePaymentResult>
        <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>
      </CreateTakePaymentResult>
    </CreateTakePaymentResponse>
  </soap12:Body>
</soap12:Envelope>