A mailing address is a saved US postal address linked to a customer. Use it for check payouts (Pay via Check), customer correspondence, and as an instrument on a Contact. You can also manage addresses directly on the customer without embedding them in a contact create call.

Scenarios

Before you begin (all scenarios)

• Customer exists and is ACTIVE.
• Every request includes the PromiseMode header.

Scenario 1: Create a mailing address

Add a new mailing address under a customer.

Request

POST /v1/customer/id/48201/mailingAddress
PromiseMode: NEVER

{
  "addressLine1": "#123, Model Town",
  "addressLine2": "Church Road",
  "city": "New York",
  "state": "NY",
  "zip": "23433",
  "name": "John Smith",
  "phone": "123-132-1331",
  "isPrimary": false,
  "usage": {
    "isPayorAddress": false
  }
}

Response

201 Created — the new address ID is in the url (Location) response header.

Scenario 2: Update a mailing address

Change the recipient name or street line on an existing address.

Request

POST /v1/customer/id/48201/mailingAddress/id/5501
PromiseMode: NEVER

{
  "name": "John Smith K",
  "addressLine1": "#1134, Model Town"
}

Response

204 No Content

Retrieve and list

• Get one address: GET /v1/customer/id/{customerId}/mailingAddress/id/{addressId}
• List all addresses: GET /v1/customer/id/{customerId}/mailingAddress

See also

• Save Payees as Contacts: save a mailing address as part of a third-party contact for check payouts
• Pay via Check: send funds to a saved mailing address