For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Reference
    • Introduction
      • Capture Payment
      • Consumer
      • Consumer Offers
      • Contact
      • Create Refund
      • Discount
      • Interval
      • Item
      • Money
      • Offer
      • Offers Request
      • Offers Response
      • Order Details
      • Payment Event
      • Payment
      • Payment (Auth)
      • Payment Schedule
      • Refund
      • Shipping Courier
LogoLogo
ReferenceModels

Contact

Example
1{
2 "name": "Joe Consumer",
3 "line1": "Level 5",
4 "line2": "390 Collins Street",
5 "area1": "Melbourne",
6 "region": "VIC",
7 "postcode": "3000",
8 "countryCode": "AU",
9 "phoneNumber": "0400 000 000"
10}
Was this page helpful?
Previous

Create Refund

Next
Built with

Response

contactobjectRequired
This data model is used for storing an individual's contact information. Mandatory fields such as **name**, **line1**, **area1**, **region**, **postcode**, and **countryCode** help in capturing vital information about a user's location. The `line2` and `area2` fields provide additional space for extended addresses, while `phoneNumber` can be used to store the user's contact number. <Warning title="Important Note"> The `area1`, `area2` and `region` properties feature localized terminology based on country. Refer to the property descriptions for insights on each country's specific usage </Warning>