Sign in

v1

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

List addresses

List addresses defined for the specified account.

get/accounts/v1/accounts/{accountId}/addresses

Path parameters

accountIdinteger required
Example:6912345

Account ID

Query parameters

activefalse | true
Example:true

Filter results based on whether the address is active or inactive.

Response

Ok

idinteger

Pismo address object ID

address_type'RESIDENTIAL' | 'COMMERCIAL' | 'OTHER'

Address type

numberinteger

Address number with numeric characters only

extended_numberstring

Address number with numeric and non-numeric characters

complementary_addressstring

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

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

creation_datestring

Date customer first acquired this address. Format = dd/mm/yyyy.

mailing_addressboolean

Is this address the mailing address?

Only one address can have this field set to true.

activeboolean

Is address active? Default is false.

org_idstring

Organization ID

account_idinteger

Account ID

last_updatestring date-time

UTC date/time when address was last updated. Format = yyyy-mm-dd:hr:mm:ss.

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 response

[
  {
    "id": 7654776,
    "address_type": "RESIDENTIAL",
    "address": {
      "line1": "1313 Mockingbird Lane",
      "line2": "Apt 4B",
      "country": "USA",
      "country_subdivision": "CA",
      "city": "San Francisco",
      "postal_code": "8675309"
    },
    "number": 456,
    "extended_number": "456 B",
    "complementary_address": "Apt 1408",
    "neighborhood": "Shady Pines",
    "zip_code": "12345-678",
    "city": "San Diego",
    "state": "BLOCKED",
    "country": "Brazil",
    "creation_date": "15/05/2022",
    "mailing_address": true,
    "active": true,
    "org_id": "TN-34778262-f4f0-464d-b4c6-a14e2dc6f4be",
    "account_id": 6912345,
    "last_update": "2019-07-22T14:35:00.000Z"
  }
]