Migrate merchants

Start migration of merchant details, such as marketplace ID, brand name, contact and creditor information.

This endpoint generates the following events:

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

Start migration of Merchant details

string
enum

Migration source type

Allowed:
migration
object
required

Additional migration details

string
length ≤ 4

Area code for the merchant's additional_phone number

string
length ≤ 25

Additional phone number of the merchant

string
length ≤ 80

Merchant address

string
length ≤ 4

Area code of the merchant's phone number.

string
length ≤ 50

Merchant's brand name

string
length ≤ 60

Merchant city

string
length ≤ 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
length ≤ 50

Merchant's additional address details. Any additional information that helps to identify the merchant's location such as building, apartment, or floor

string
length ≤ 50

Name of a merchant representative

string
length ≤ 30

Merchant address country name

string
length ≤ 14

Merchant's document number

string
length ≤ 255

Merchant's email address

string
length ≤ 45

Merchant category code that indicates business type. Use the Get business category endpoint to get a list of business categories and their external codes.

int64

Marketplace ID from Pismo Control Center

string
length ≤ 15

Merchant's municipal registration number. In Brazil, this is the ID number that a business receives when it registers with the municipal tax department.

string
length ≤ 100

Merchant's name

string
length ≤ 50

Merchant's neighborhood details. In Brazil, addresses include the neighborhood name, but in other countries, they might not.

int64

Merchant's address number

string
length ≤ 25

Merchant's phone number. Parentheses and dashes are optional.

int64

Program ID for the merchant account

string
length ≤ 2

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

string
length ≤ 9

Merchant's postal code. Postal codes are called zip codes in the United States. You can also use other types of postal code here.

creditor
object

Response from merchant creditor. The merchant creditor is the entity the merchant receives money from when settling a transaction. The entity can be an external bank account or a Pismo account.

metadata
object

Merchants's metadata

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Responses
202

Accepted

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json