Update merchant

Update merchant by ID.

For more information about merchants, see the Seller management overview guide.
This endpoint generates a Merchant updated event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Merchant ID

Body Params

Request body

string
length between 1 and 14

Merchant document number. This is the government document code, such as a government-issued tax ID.

string
required
length between 1 and 100

Merchant name

string
length between 1 and 128

Merchant brand name. Note that this is different from a merchant's legal registered name. For example, Great Company as opposed to Great Company, LLC (legal entity name).

string
length between 1 and 128

Merchant's municipal registration number

string
length between 1 and 128

Name of contact

string
required

Email address

string
length between 1 and 9

Postal code. This is called a zip code in the United States, but you can use other types of postal codes.

string
length between 1 and 80

Name of the street, avenue, or primary thoroughfare of the address

string
length between 1 and 50

Additional address details that help pinpoint the exact location, such as building, apartment, or floor

string
length between 1 and 50

Name of the neighborhood or administrative region where the address is located

string
length between 1 and 2

Abbreviation or full name of the state, province, or administrative division

string
length between 1 and 60

Name of the city or municipality

string
length between 1 and 30

Full name of the country according to international standards or local registry

int64

Numerical identifier for the specific location within a street or avenue

string

Area code. The US, Canada, and certain other countries divide their telephone service into regions, which are identified by numbers called area codes. In the US, for example, area codes are 3-digit numbers.

string
length ≤ 25

Phone number. Parentheses and dashes are optional.

string

Additional area code (for additional_phone)

string

Number for an additional phone. Parentheses and dashes are optional.

string
length between 1 and 128

Code for merchant category. The category is the type of business. You can use the endpoint Retrieves business categories corresponding to query parameters to get a list of business categories and their external codes.

creditor
object

This is the entity from which the merchant receives money when a transaction is settled. It should be a Pismo account.

string
length between 1 and 50

Official seven-digit numeric code of the city according to the IBGE (Brazilian Institute of Geography and Statistics) code table. Used only for cities in Brazil; this code is unique per city.

string

Internal ID used by client to reference a merchant in their domain.

Headers
string

Content type

string

Authorization token. This is a regular access token, which does not need to include an account ID.

Responses
200

OK

400

Bad Request

401

Access token is missing or invalid

500

Internal server error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!