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
  • Online API
    • API Environments
    • Direct Payment Flow
    • REST
    • HTTPS
    • Dates
    • Pagination
    • Authentication
    • Idempotent Requests
    • Timeouts
    • API Simulator
  • Models
    • Introduction
    • Contact Object
    • Consumer Object
    • Discount Object
    • Item Object
    • Money Object
    • Order Details Object
    • Payment Object
    • Refund Object
    • Shipping Courier Object
  • Service Status
    • GETPing
  • Configuration
    • GETGet Configuration
  • Orders
    • Introduction
    • GETGet Order
    • POSTCreate Order
  • Javascript afterpay.js
    • Information
    • Redirect Method
  • Payments
    • Introduction
    • POSTCapture Payment
    • PUTUpdate Shipping Courier
    • GETGet Payment By Order ID
    • GETGet Payment By Token
    • GETList Payment(s)
    • POSTCreate Refund
    • PUTUpdate Payment by Order ID
    • POSTReverse Payment By Token
  • Errors
    • Introduction
    • Get Errors
    • Put/Post Errors
  • Reference
LogoLogo
On this page
  • Attributes
  • Example Contact Object
  • Australia
  • New Zealand
  • United States of America
Models

Contact object

Was this page helpful?
Previous

Consumer Object

Next
Built with

Attributes

AttributeTypeDescription
namestring (required)Full name of contact. Limited to 255 characters.
line1string (required)First line of the address. Limited to 128 characters.
line2stringSecond line of the address. Limited to 128 characters.
suburbstringCity or suburb name. Limited to 128 characters.
statestringState (or Town/City for NZ). Limited to 128 characters.
postcodestring (required)ZIP or postal code. Limited to 128 characters.
countryCodestring (required)The two-character ISO 3166-1 country code.
phoneNumberstring (required)The phone number, in E.123 format. Limited to 32 characters.

Example Contact Object

Australia

1{
2  "name": "Joe Consumer",
3  "line1": "Level 5",
4  "line2": "406 Collins Street",
5  "suburb": "Melbourne",
6  "state": "VIC",
7  "postcode": "3000",
8  "countryCode": "AU",
9  "phoneNumber": "0400 000 000"
10}

New Zealand

1{
2  "name": "Joe Consumer",
3  "line1": "75 Queen St",
4  "suburb": "Auckland Central",
5  "state": "Auckland",
6  "postcode": "1010",
7  "countryCode": "NZ",
8  "phoneNumber": "0200 000 000"
9}

United States of America

1{
2  "name": "Joe Consumer",
3  "line1": "3655 Lawton St",
4  "suburb": "San Francisco",
5  "state": "CA",
6  "postcode": "94122",
7  "countryCode": "US",
8  "phoneNumber": "(415) 200-0000"
9}