v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Addresses

Create address

Create a new address for the specified account.

This endpoint generates an Address created event.

post/accounts/v1/accounts/{accountId}/addresses

Path parameters

accountIdinteger required

Example:6912345

Account ID

Request body

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

Address type

numberstring required

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"

zip_codestring required

Zip/postal code

citystring required

Address city

state'' | 'BLOCKED' | 'UNBLOCKED' required

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 required

Address country

neighborhoodstring required

Address neighborhood. Some countries use neighborhood in addresses.

activeboolean

Is address active? Default is false.

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.

mailing_addressboolean

Is this address the mailing address?

Only one address can have this field set to true.

Example request

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

Response

The address was successfully created

idinteger

Example response

{
  "id": 1472162
}