bitPay Web Service

bitPay

Click here for a complete list of operations.

createInvoice

Request invoice with passed values

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 /ctapi/services/ctCryptoPay/bitPay.asmx HTTP/1.1
Host: catalinatechnology.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.catalinaTechnology.com/services/ctCryptoPay/createInvoice"

<?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:Header>
    <ctCryptoPayHeader xmlns="http://www.catalinaTechnology.com/services/ctCryptoPay">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
    </ctCryptoPayHeader>
  </soap:Header>
  <soap:Body>
    <createInvoice xmlns="http://www.catalinaTechnology.com/services/ctCryptoPay">
      <price>double</price>
      <currency>string</currency>
      <posData>string</posData>
      <notificationURL>string</notificationURL>
      <transactionSpeed>string</transactionSpeed>
      <fullNotifications>boolean</fullNotifications>
      <notificationEmail>string</notificationEmail>
      <redirectURL>string</redirectURL>
      <orderID>string</orderID>
      <itemDesc>string</itemDesc>
      <itemCode>string</itemCode>
      <physical>boolean</physical>
      <buyerName>string</buyerName>
      <buyerAddress1>string</buyerAddress1>
      <buyerAddress2>string</buyerAddress2>
      <buyerCity>string</buyerCity>
      <buyerState>string</buyerState>
      <buyerZip>string</buyerZip>
      <buyerCountry>string</buyerCountry>
      <buyerEmail>string</buyerEmail>
      <buyerPhone>string</buyerPhone>
    </createInvoice>
  </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>
    <createInvoiceResponse xmlns="http://www.catalinaTechnology.com/services/ctCryptoPay">
      <createInvoiceResult>
        <id>string</id>
        <url>string</url>
        <posData>string</posData>
        <status>string</status>
        <price>double</price>
        <currency>string</currency>
        <btcPrice>double</btcPrice>
        <invoiceTime>double</invoiceTime>
        <expirationTime>double</expirationTime>
        <currentTime>double</currentTime>
      </createInvoiceResult>
    </createInvoiceResponse>
  </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 /ctapi/services/ctCryptoPay/bitPay.asmx HTTP/1.1
Host: catalinatechnology.com
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:Header>
    <ctCryptoPayHeader xmlns="http://www.catalinaTechnology.com/services/ctCryptoPay">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
    </ctCryptoPayHeader>
  </soap12:Header>
  <soap12:Body>
    <createInvoice xmlns="http://www.catalinaTechnology.com/services/ctCryptoPay">
      <price>double</price>
      <currency>string</currency>
      <posData>string</posData>
      <notificationURL>string</notificationURL>
      <transactionSpeed>string</transactionSpeed>
      <fullNotifications>boolean</fullNotifications>
      <notificationEmail>string</notificationEmail>
      <redirectURL>string</redirectURL>
      <orderID>string</orderID>
      <itemDesc>string</itemDesc>
      <itemCode>string</itemCode>
      <physical>boolean</physical>
      <buyerName>string</buyerName>
      <buyerAddress1>string</buyerAddress1>
      <buyerAddress2>string</buyerAddress2>
      <buyerCity>string</buyerCity>
      <buyerState>string</buyerState>
      <buyerZip>string</buyerZip>
      <buyerCountry>string</buyerCountry>
      <buyerEmail>string</buyerEmail>
      <buyerPhone>string</buyerPhone>
    </createInvoice>
  </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>
    <createInvoiceResponse xmlns="http://www.catalinaTechnology.com/services/ctCryptoPay">
      <createInvoiceResult>
        <id>string</id>
        <url>string</url>
        <posData>string</posData>
        <status>string</status>
        <price>double</price>
        <currency>string</currency>
        <btcPrice>double</btcPrice>
        <invoiceTime>double</invoiceTime>
        <expirationTime>double</expirationTime>
        <currentTime>double</currentTime>
      </createInvoiceResult>
    </createInvoiceResponse>
  </soap12:Body>
</soap12:Envelope>