POST api/v1/AccountAdminAPI/PurchaseCredits

Purchase Credits

Request Information

URI Parameters

None.

Body Parameters

AccountPurchase
NameDescriptionTypeAdditional information
Billing

BillingInfo

None.

PurchaseID

globally unique identifier

None.

PurchaseOrder

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Billing": {
    "Address": "sample string 1",
    "Company": "sample string 2",
    "Email": "sample string 3",
    "Mobile": "sample string 4",
    "Phone": "sample string 5"
  },
  "PurchaseID": "c81f583f-a68c-4ee2-8e01-1c3fdbaffa59",
  "PurchaseOrder": "sample string 2"
}

application/xml, text/xml

Sample:
<AccountPurchase xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Billing>
    <Address>sample string 1</Address>
    <Company>sample string 2</Company>
    <Email>sample string 3</Email>
    <Mobile>sample string 4</Mobile>
    <Phone>sample string 5</Phone>
  </Billing>
  <PurchaseID>c81f583f-a68c-4ee2-8e01-1c3fdbaffa59</PurchaseID>
  <PurchaseOrder>sample string 2</PurchaseOrder>
</AccountPurchase>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfPurchase
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfPurchase

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "Currency": "sample string 1",
      "DatePurchased": "2022-01-27T11:56:12.1028935+00:00",
      "GrossTotal": 3.1,
      "ID": "7b14294b-7da7-4700-b5fc-8fc97cc13dc5",
      "InvoiceNumber": 1,
      "NetTotal": 5.1,
      "Paid": true,
      "PurchaseType": "sample string 7",
      "Quantity": 8.1,
      "Tax": 9.1,
      "UnitPrice": 10.1
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfPurchase xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <Currency>sample string 1</Currency>
      <DatePurchased>2022-01-27T11:56:12.1028935+00:00</DatePurchased>
      <GrossTotal>3.1</GrossTotal>
      <ID>7b14294b-7da7-4700-b5fc-8fc97cc13dc5</ID>
      <InvoiceNumber>1</InvoiceNumber>
      <NetTotal>5.1</NetTotal>
      <Paid>true</Paid>
      <PurchaseType>sample string 7</PurchaseType>
      <Quantity>8.1</Quantity>
      <Tax>9.1</Tax>
      <UnitPrice>10.1</UnitPrice>
    </Detail>
  </ResponseData>
</ResponseOfPurchase>