POST api/v1/purchase

Purchase multiple or single skus - preferred way to purchase anything.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		PurchasePackagesRequest	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "170200123",
    "Key": "467512342123"
  },
  "Request": {
    "Email": "larry@newmedia.com",
    "Skus": [
      {
        "Sku": "MP001",
        "Quantity": "1"
      },
      {
        "Sku": "MP002",
        "Quantity": "2"
      }
    ],
    "PaymentMethod": {
      "Name": {
        "FirstName": "Larry",
        "LastName": "Raddler",
        "CompanyName": "Sanmple Plc",
        "MiddleName": ""
      },
      "PaymentType": "1/2/3",
      "BankRequest": {
        "RoutingNumber": "0012345",
        "BankAccountNumber": "123456789",
        "AccountHolderName": "Larry Raddler",
        "BillingAddress": null,
        "SaveToFile": "true/false"
      },
      "CardPayment": {
        "Card": {
          "CardNumber": "4000000000000001",
          "ExpiryDate": "12/19 (MM/YY)",
          "CVV": "123 (3 or 4 digits, depending upon card scheme)"
        },
        "CaptureMethod": "3 - ecommerce",
        "BillingAddress": {
          "HouseNumber": "123 (optional)",
          "ApartmentNumber": "4A (optional)",
          "Street": "Welling Ave (optional)",
          "Street2": "Houseblocks (optional)",
          "City": "Saverton (optional)",
          "Zip": "90001",
          "County": "King (optional)",
          "State": "WA (optional)",
          "Country": "USA",
          "CountryName": null,
          "Country2AlphaCode": null,
          "Country3AlphaCode": null,
          "CountryNumericCode": null
        },
        "SaveToFile": "true/false"
      },
      "StoredProfile": {
        "CustomerProfileId": "1234567",
        "PaymentProfileId": "2345678"
      },
      "CurrencyCode": "USD (see ISO 4217 for correct currency codes)",
      "Authorizer": "Authorizer ID"
    },
    "TransactionDateTime": "2025-04-19 08:29:17 (YYYY-MM-DD HH:MM:SS - UTC format)",
    "TransactionReference": "Trial extension",
    "Discount": {
      "DiscountCode": "1234",
      "Product": "Workstation"
    },
    "Marketing": {
      "Motion": "Workstation Beta"
    },
    "RevenuePartner": null,
    "UpdateRenderRocket": "false"
  }
}

application/xml, text/xml

Sample:

<PurchasePackagesBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Authentication>
    <Id>170200123</Id>
    <Key>467512342123</Key>
  </Authentication>
  <Request>
    <Discount>
      <DiscountCode>1234</DiscountCode>
      <Product>Workstation</Product>
    </Discount>
    <Email>larry@newmedia.com</Email>
    <Marketing>
      <Motion>Workstation Beta</Motion>
    </Marketing>
    <PaymentMethod>
      <Authorizer>Authorizer ID</Authorizer>
      <BankRequest>
        <AccountHolderName>Larry Raddler</AccountHolderName>
        <BankAccountNumber>123456789</BankAccountNumber>
        <BillingAddress i:nil="true" />
        <RoutingNumber>0012345</RoutingNumber>
        <SaveToFile>true/false</SaveToFile>
      </BankRequest>
      <CardPayment>
        <BillingAddress>
          <ApartmentNumber>4A (optional)</ApartmentNumber>
          <City>Saverton (optional)</City>
          <Country>USA</Country>
          <Country2AlphaCode i:nil="true" />
          <Country3AlphaCode i:nil="true" />
          <CountryName i:nil="true" />
          <CountryNumericCode i:nil="true" />
          <County>King (optional)</County>
          <HouseNumber>123 (optional)</HouseNumber>
          <State>WA (optional)</State>
          <Street>Welling Ave (optional)</Street>
          <Street2>Houseblocks (optional)</Street2>
          <Zip>90001</Zip>
        </BillingAddress>
        <CaptureMethod>3 - ecommerce</CaptureMethod>
        <Card>
          <CVV>123 (3 or 4 digits, depending upon card scheme)</CVV>
          <CardNumber>4000000000000001</CardNumber>
          <ExpiryDate>12/19 (MM/YY)</ExpiryDate>
        </Card>
        <SaveToFile>true/false</SaveToFile>
      </CardPayment>
      <CurrencyCode>USD (see ISO 4217 for correct currency codes)</CurrencyCode>
      <Name>
        <CompanyName>Sanmple Plc</CompanyName>
        <FirstName>Larry</FirstName>
        <LastName>Raddler</LastName>
        <MiddleName></MiddleName>
      </Name>
      <PaymentType>1/2/3</PaymentType>
      <StoredProfile>
        <CustomerProfileId>1234567</CustomerProfileId>
        <PaymentProfileId>2345678</PaymentProfileId>
      </StoredProfile>
    </PaymentMethod>
    <RevenuePartner i:nil="true" />
    <Skus>
      <SkuPackage>
        <Quantity>1</Quantity>
        <Sku>MP001</Sku>
      </SkuPackage>
      <SkuPackage>
        <Quantity>2</Quantity>
        <Sku>MP002</Sku>
      </SkuPackage>
    </Skus>
    <TransactionDateTime>2025-04-19 08:29:17 (YYYY-MM-DD HH:MM:SS - UTC format)</TransactionDateTime>
    <TransactionReference>Trial extension</TransactionReference>
    <UpdateRenderRocket>false</UpdateRenderRocket>
  </Request>
</PurchasePackagesBindingModel>

Response Information

Resource Description

PricingPackagesOutgoingModel

Name	Description	Type	Additional information
Message		MessageModel	None.
Response		IPricingPackageResponseModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": {
    "Code": "sample string 1",
    "Description": "sample string 2"
  },
  "Response": null
}

application/xml, text/xml

Sample:

<PricingPackagesOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Message>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </Message>
  <Response i:nil="true" />
</PricingPackagesOutgoingModel>