> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://allianz.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://allianz.ferndocs.com/_mcp/server.

# Purchase examples

## Purchase request

**`Purchase request`**

```json title="Purchase request" maxLines=40
{
  "Partner": {
    "UserID": "AirlineCompany",
    "Password": "YOUR_PASSWORD"
  },
  "PurchasesRequest": {
    "Accam": "F999999",
    "BusinessUnit": "US",
    "TransactionID": "CDJSONTesting",
    "Purchases": {
      "Purchase": [
        {
          "PartnerBookingID": "CDJSON0011",
          "InsuranceBookingDetails": {
            "PurchaseDateTime": "2018-08-10",
            "Method": "ONLINE",
            "Status": "NEW",
            "Type": "ADD",
            "Currency": "USD",
            "TotalCoverageAmount": "2562.84",
            "TotalPrice": "192.22",
            "TotalPremiumPrice": "192.22",
            "Purchaser": {
              "FirstName": "John",
              "MiddleInitial": "T",
              "LastName": "Doe",
              "BillingAddress": {
                "Street": "1234 Road Street",
                "Street2": "",
                "City": "New York",
                "Region": "NY",
                "PostalCode": "10023",
                "Country": "US"
              },
              "EmailAddress": "example@allianz.com",
              "PhoneNumber": "2121234567"
            },
            "FulfillmentMethod": "EMAIL",
            "PaymentMethod": "CC",
            "CreditCard": {
              "CardholderName": "John Doe",
              "ExpireMonth": "5",
              "ExpireYear": "2021",
              "CardNumber": "4012XXXXXXXX0026",
              "CardType": "VI",
              "SecurityCode": ""
            }
          },
          "GadgetDetails": {
            "BrowserType": "",
            "BrowserVersion": "",
            "DeviceCategory": "Desktop",
            "DeviceType": "Apple",
            "OperatingSystem": "",
            "OperatingSystemVersion": "",
            "RequestingPlatform": "None",
            "RequestingPlatformVersion": ""
          },
          "TravelBookingDetails": {
            "Currency": "USD",
            "TotalTripCost": "2562.84",
            "TotalMiles": "1",
            "PNR": "123DD",
            "DepositDate": "2018-08-10",
            "CustomerID": "12345",
            "TravelAgent": "www.airlinecompany.com"
          },
          "TravelDetails": {
            "DepartureDate": "2018-12-17",
            "ReturnDate": "2018-12-31",
            "RentalCarStartDate": "",
            "RentalCarEndDate": "",
            "Origin": {
              "Code": "JFK",
              "Region": "NY",
              "Country": "US"
            },
            "Destination": {
              "Code": "CDG",
              "Region": "",
              "Country": "FR"
            },
            "Providers": {
              "Provider": [
                {
                  "Code": "",
                  "Name": "www.airlinecompany.com"
                }
              ]
            },
            "RentalCarAgency": ""
          },
          "ProductDetails": {
            "Product": [
              {
                "Sequence": "0",
                "QuoteID": "2052521881115360218",
                "ProductID": "001004037",
                "InsuredDetails": {
                  "Insured": [
                    {
                      "InsuredSequence": "0",
                      "InsuredType": "PRIMARY",
                      "FirstName": "John",
                      "MiddleInitial": "T",
                      "LastName": "Doe",
                      "Birthdate": "1980-05-10",
                      "Gender": "Male",
                      "IPaddress": "",
                      "InsuredAddress": {
                        "Street": "1234 Road Street",
                        "Street2": "",
                        "City": "New York",
                        "Region": "NY",
                        "PostalCode": "10023",
                        "Country": "USA"
                      },
                      "PhoneNumber": "6512628167",
                      "CustomerID": "12345",
                      "NumberOfRooms": "",
                      "Memberships": {
                        "Name": "TopBuyer",
                        "Type": "Gold",
                        "Number": "123456"
                      }
                    },
                    {
                      "InsuredSequence": "1",
                      "InsuredType": "Other",
                      "FirstName": "Jane",
                      "LastName": "Doe",
                      "InsuredAddress": {
                        "Region": "NY",
                        "PostalCode": "10023",
                        "Country": "USA"
                      }
                    }
                  ]
                },
                "CoverageAmount": "2562.84",
                "Price": "192.22",
                "PremiumPrice": "192.22"
              }
            ]
          }
        }
      ]
    }
  }
}
```

#### Field notes

**`PurchasesRequest.Accam`**

The Accam is a unique code used by AWP to identify a Partner. The Accam is referenced in the Quote Request as ExternalCode.

---

**`PurchasesRequest.TransactionID`**

Unique identifier for each XML transaction (request and response) that is generated by the partner. Typically a cart number

---

**`PurchasesRequest.Purchases.Purchase[].PartnerBookingID`**

PartnerBookingID is a unique key created by the Partner and cannot exceed 25 characters.

---

**`PurchasesRequest.Purchases.Purchase[].TravelBookingDetails.TotalTripCost`**

The total cost of the trip being insured.

---

**`PurchasesRequest.Purchases.Purchase[].InsuranceBookingDetails.TotalPrice`**

The total price for insurance.

---

**`PurchasesRequest.Purchases.Purchase[].InsuranceBookingDetails.FulfillmentMethod`**

Set FulfillmentMethod to CC if payment is Credit Card and include the CreditCard object.

---

**`PurchasesRequest.Purchases.Purchase[].TravelDetails`**

This object is used to provide individual trip details.

---

**`PurchasesRequest.Purchases.Purchase[].ProductDetails.Product[].QuoteID`**

Value populated from the quoteId returned in the Quote Response.

---

**`PurchasesRequest.Purchases.Purchase[].ProductDetails.Product[].ProductID`**

Value populated from the productCode element in the Quote Response.

---

**`PurchasesRequest.Purchases.Purchase[].ProductDetails.Product[].InsuredDetails.Insured[].InsuredSequence`**

Sequence is incremented for each Insured object added.

---

## Purchase response

**`Purchase response`**

```json title="Purchase response" maxLines=40
{
  "purchasesResponse": {
    "transactionID": "CDJSONTesting",
    "status": {
      "code": "SUCCESS",
      "message": "All products processed."
    },
    "purchases": {
      "purchase": [
        {
          "partnerBookingID": "CDJSON0011",
          "orderID": 25028941,
          "status": "CHARGED",
          "productDetails": {
            "product": [
              {
                "sequence": 0,
                "productID": "001004037",
                "productBookingID": "CDJSON00011"
              }
            ]
          }
        }
      ]
    }
  }
}
```

#### Field notes

**`purchasesResponse.status.code`**

Value will be "SUCCESS" if transaction succeeds, otherwise value is "FAILURE".

---

## Related

#### [Purchase Web Service](/integration-guide/purchase-web-service)

How the purchase flow works.

#### [Purchase request dictionary](/in-path-offers/server-side/documentation/data-dictionaries/purchase-request)

Every element you can send.

#### [Purchase response dictionary](/in-path-offers/server-side/documentation/data-dictionaries/purchase-response)

Every element AWP returns.