Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Addresses

Update address

Update an address.

This endpoint generates an Address updated event.

patch/accounts/v1/accounts/{accountId}/addresses/{addressId}

Path parameters

accountIdinteger required
Example:6912345

Account ID

addressIdinteger required
Example:456

Address ID

Request body

type'RESIDENTIAL' | 'COMMERCIAL' | 'OTHER'

Address type

numberstring

Address number as string or integer.

If you enter numeric characters, they are saved in the number address object field.

If you enter any non-numeric characters, all characters are saved in the extended_number address object field.

For example, if you enter "12 A", it gets saved as follows:

  • number = 12
  • extended_number = "12 A"
neighborhoodstring

Address neighborhood. Some countries use neighborhood in addresses.

zip_codestring

Zip/postal code

citystring

Address city

state'' | 'BLOCKED' | 'UNBLOCKED'

Is card blocked or not in the network brand? When the state is empty, it means the network brand did not successfully receive any action.

countrystring

Address country

activeboolean

Is address active? Default is false.

mailing_addressboolean

Is this address the mailing address?

Only one address can have this field set to true.

complementary_addressstring

Any additional information such as suite, apt., and so on.

custom_fieldsCustomFields

Name-value fields for any account-related data your organization needs to store at Pismo. This field can have its values validated against the JSON schema stored at the division (referenced by the division_code) field schema.

Example request

{
  "type": "RESIDENTIAL",
  "address": {
    "line1": "1313 Mockingbird Lane",
    "line2": "Apt 4B",
    "country": "USA",
    "country_subdivision": "CA",
    "city": "San Francisco",
    "postal_code": "8675309"
  },
  "neighborhood": "Shady Pines",
  "zip_code": "12345-678",
  "city": "San Diego",
  "state": "BLOCKED",
  "country": "Brazil",
  "active": true,
  "mailing_address": true,
  "complementary_address": "Apt 1408"
}

Response

The address was successfully updated

idinteger

Pismo address object ID

Example response

{
  "id": 7654776
}