Sign in

v1

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

Get organization

Returns information about a specific organization.

get/orgs-core/v1/orgs/{id}

Path parameters

idstring required
Example:TN-cc8f8b89-233a-4582-9f36-63ee85278d6d

Org ID

Headers

x-tenantstring required
Example:TN-cc8f8b89-233a-4582-9f36-63ee85278d6d

Pismo organization ID

Response

Org data

idstring

Organization ID

official_namestring

Your company's legal name

org_namestring

Organization display name on the Pismo platform

start_datestring date

Date to start applying the benchmark rate in the accrual process. Format = YYYY-MM-DD.

expiration_datestring

Card expiration date (format = yymm). If passed, the card expiration date is not calculated using the "Card expiration (# of months)" program parameter.

document_numberstring

Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.

addressstring

Your company's street name

numberinteger

Address number with numeric characters only

complementary_addressstring

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

neighborhoodstring

Address neighborhood. Some countries use neighborhood in addresses.

zipcodestring

Cardholder 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

legal_proxy_namestring

Name of your organization's legal representative (person or other entity)

legal_proxy_documentstring

ID (such as a government tax ID number) of your organization's legal representative

responsiblestring

Email of person at organization who can be contacted if necessary.

currency_numeric_codestring

Numeric code (ISO 4217) for the currency used by the program.<br> minLength: 3 maxLength: 3

timezonestring

Division timezone in timezone database format.<br> This value is used in the calculations for holidays, weekends, and daily balances. If a timezone is not specified, the division inherits the timezone from its parent division. If the parent division also lacks a specified timezone, Pismo defaults to using UTC. To clear this field, specify an empty string.

language'en-US' | 'pt-BR'

Language. Default is en-US

country_codestring

<a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166 Alpha-3</a> program country code. For example, BRA = Brazil.

cycle_closingstring

Cycle closing time. Format = HH:MM:SS

holiday_calendar_idnumber

Holiday calendar ID.

Example response

{
  "id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
  "official_name": "Acme Corporation",
  "org_name": "Acme Corporation",
  "start_date": "2024-09-10",
  "expiration_date": "2803",
  "document_number": "7777888hh",
  "address": "Main Street",
  "number": 456,
  "complementary_address": "Apt 1408",
  "neighborhood": "Shady Pines",
  "zipcode": "01701000",
  "city": "San Diego",
  "state": "BLOCKED",
  "country": "Brazil",
  "legal_proxy_name": "Acme Corporation LTDA",
  "legal_proxy_document": "123456",
  "currency_numeric_code": "840",
  "timezone": "America/New_York",
  "language": "en-US",
  "country_code": "BRA",
  "cycle_closing": "12:00:00",
  "holiday_calendar_id": 8675309
}