Buyer Updated Event

Buyer updated event representing a state change in buyer data.

Headers:

Ce-Type - buyer_updated
Ce-Source - breadpayments.webhooks.buyer_management

{
  "identity": {
    "tenantID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
    "buyerID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
    "merchantID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
    "partnerID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
    "programID": "dc0dc633-1760-4d43-ba1d-da94ed701f06"
  },
  "timestamp": "2020-12-31T15:10:55Z",
  "buyer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "tenantID": "f95ac700-4c8f-4a38-a8d1-1582733edd5b",
    "buyerIdentity": {
      "tenantID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
      "buyerID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
      "merchantID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
      "partnerID": "dc0dc633-1760-4d43-ba1d-da94ed701f06",
      "programID": "dc0dc633-1760-4d43-ba1d-da94ed701f06"
    },
    "primaryContactID": "6cba637d-8417-4481-9975-f1d80e1f1dfb",
    "contacts": {
      "property1": {
        "address": {
          "address1": "156 5th Avenue",
          "address2": "string",
          "locality": "New York",
          "postalCode": "10019",
          "region": "US-NY",
          "country": "US",
          "addressType": "Firm"
        },
        "buyerID": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
        "contactType": "PRIMARY",
        "createdAt": "2020-12-31T15:10:55Z",
        "email": "john.doe@gmail.com",
        "id": "f322210a-e814-4b1b-a8bf-007a3e765bb9",
        "name": {
          "givenName": "John",
          "familyName": "Doe",
          "additionalName": "string"
        },
        "phone": "+14539842345",
        "updatedAt": "2020-12-31T15:10:55Z"
      },
      "property2": {
        "address": {
          "address1": "156 5th Avenue",
          "address2": "string",
          "locality": "New York",
          "postalCode": "10019",
          "region": "US-NY",
          "country": "US",
          "addressType": "Firm"
        },
        "buyerID": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
        "contactType": "PRIMARY",
        "createdAt": "2020-12-31T15:10:55Z",
        "email": "john.doe@gmail.com",
        "id": "f322210a-e814-4b1b-a8bf-007a3e765bb9",
        "name": {
          "givenName": "John",
          "familyName": "Doe",
          "additionalName": "string"
        },
        "phone": "+14539842345",
        "updatedAt": "2020-12-31T15:10:55Z"
      }
    },
    "buyerStatus": "ACTIVE",
    "buyerSubStatus": "ACTIVE",
    "createdAt": "2020-12-31T15:10:55Z",
    "updatedAt": "2020-12-31T15:10:55Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
identity	object	true	none	The claims that determines the access level of the caller.
➥ tenantID	string(uuid)	true	none	An UUID that represents a tenant.
➥ buyerID	string(uuid)¦null	false	none	An UUID that represents a buyer.
➥ merchantID	string(uuid)¦null	false	none	An UUID that represents a merchant.
➥ partnerID	string(uuid)¦null	false	none	An UUID that represents a partner.
➥ programID	string(uuid)¦null	false	none	An UUID that represents a program.
timestamp	string(date-time)	true	none	The timestamp value formatted per RFC3339. This does not allow nulls.
buyer	object	true	none	none
➥ id	string(uuid)	true	read-only	Unique ID associated with this buyer.
➥ tenantID	string(uuid)	true	read-only	Tenant associated with this buyer.
➥ buyerIdentity	object	true	none	The claims that determines the access level of the caller.
➥➥ tenantID	string(uuid)	true	none	An UUID that represents a tenant.
➥➥ buyerID	string(uuid)¦null	false	none	An UUID that represents a buyer.
➥➥ merchantID	string(uuid)¦null	false	none	An UUID that represents a merchant.
➥➥ partnerID	string(uuid)¦null	false	none	An UUID that represents a partner.
➥➥ programID	string(uuid)¦null	false	none	An UUID that represents a program.
➥ primaryContactID	string(uuid)	true	read-only	Primary contact for this buyer.
➥ contacts	object	true	none	BuyerContactMap represents a mapping of buyer contact IDs to contacts
➥➥ additionalProperties	object	false	none	BuyerContact represents a set of contact information.
➥➥➥ address	object	false	none	Represents a fully defined address for an entity
➥➥➥➥ address1	string	true	none	First address line
➥➥➥➥ address2	string	false	none	Second address line
➥➥➥➥ locality	string	true	none	The locality (e.g. City) of the address.
➥➥➥➥ postalCode	string	true	none	The administrative postal code (e.g. Zip Code)
➥➥➥➥ region	string	true	none	The region or first-level administration division (e.g. State/Province) of the address.
➥➥➥➥ country	string	true	none	The two character ISO-3166-1 country code.
➥➥➥➥ addressType	string	false	read-only	Represents the type of address.
➥➥➥ buyerID	string(uuid)	false	read-only	ID of the buyer associated with this contact.
➥➥➥ contactType	string	false	none	Optional. Represents the type of contact.
➥➥➥ createdAt	string(date-time)	false	none	Time this entity was created.
➥➥➥ email	string(email)	true	none	Email address.
➥➥➥ id	string(uuid)	false	read-only	Unique ID associated with this contact.
➥➥➥ name	object	true	none	Full name.
➥➥➥➥ givenName	string	true	none	Given name
➥➥➥➥ familyName	string	true	none	Family name
➥➥➥➥ additionalName	string	false	none	Additional name, if any
➥➥➥ phone	string	true	none	Phone number.
➥➥➥ updatedAt	string(date-time)	false	none	Time this entity was last updated.
➥ buyerStatus	string	false	none	Status represents buyer status as string. Options available will depend on tenant level configurations
➥ buyerSubStatus	string	false	none	Status represents buyer status as string. Options available will depend on tenant level configurations
➥ createdAt	string(date-time)	true	none	Time this entity was created.
➥ updatedAt	string(date-time)	true	none	Time this entity was updated.

Enumerated Values

Value
Firm
GeneralDelivery
HighRise
POBox
RuralRoute
Street
NoMatch
InternationalNone
InternationalAdministrativeArea
InternationalLocality
InternationalThoroughfare
InternationalPremise
InternationalDeliveryPoint
Other

PRIMARY
HOME
WORK
OTHER
BILLING
SHIPPING