NameDescriptionType
APIKey

Your public API Key which can be found in your account

globally unique identifier
Signature

Your encrypted signature which includes your APIKey, UserId and Nonce, then salted with your API Secret

string
Nonce

A constantly incrementing integer, you can use a timestamp for example. Example: 34235

integer

Request Formats

application/json, text/json

Sample:
{
  "APIKey": "55504c67-4ab1-461d-977a-a418708d6532",
  "Signature": "sample string 2",
  "Nonce": 3
}

application/xml, text/xml

Sample:
<APIKeyParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCPayments.Models">
  <APIKey>55504c67-4ab1-461d-977a-a418708d6532</APIKey>
  <Nonce>3</Nonce>
  <Signature>sample string 2</Signature>
</APIKeyParameters>

Response Information

Resource Description

NameDescriptionType
CompanyName

string
Website

string
LogoURL

string
MinSale

decimal number
MaxSale

decimal number
CheckoutButtonsActive

boolean
SettleCurrency

string
NotificationURL

string
APIWithdrawBTC

boolean
APIBuySell

boolean
LNActive

boolean
Rolling30DayLimit

decimal number
Rolling24HourLimit

decimal number
MaxBTCWithdraw

decimal number

Response Formats

application/json, text/json

Sample:
{
  "CompanyName": "sample string 1",
  "Website": "sample string 2",
  "LogoURL": "sample string 3",
  "MinSale": 4.0,
  "MaxSale": 5.0,
  "CheckoutButtonsActive": true,
  "SettleCurrency": "sample string 7",
  "NotificationURL": "sample string 8",
  "APIWithdrawBTC": true,
  "APIBuySell": true,
  "LNActive": true,
  "Rolling30DayLimit": 12.0,
  "Rolling24HourLimit": 13.0,
  "MaxBTCWithdraw": 1.0
}

application/xml, text/xml

Sample:
<MerchantSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCPayments.Models">
  <APIBuySell>true</APIBuySell>
  <APIWithdrawBTC>true</APIWithdrawBTC>
  <CheckoutButtonsActive>true</CheckoutButtonsActive>
  <CompanyName>sample string 1</CompanyName>
  <LNActive>true</LNActive>
  <LogoURL>sample string 3</LogoURL>
  <MaxBTCWithdraw>1</MaxBTCWithdraw>
  <MaxSale>5</MaxSale>
  <MinSale>4</MinSale>
  <NotificationURL>sample string 8</NotificationURL>
  <Rolling24HourLimit>13</Rolling24HourLimit>
  <Rolling30DayLimit>12</Rolling30DayLimit>
  <SettleCurrency>sample string 7</SettleCurrency>
  <Website>sample string 2</Website>
</MerchantSettings>