PIpismo
Merchant migration

Migrate merchants

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

This endpoint generates the following events:

post/v1/migrations/merchants

Request

  • Base URL
    https://gw-pci.pismolabs.io/migrations
  • URL
    https://gw-pci.pismolabs.io/migrations/v1/migrations/merchants
  • Auth
    HTTP bearer

Request body

origin'FILE' | 'API'

Migration source type

additional_area_codestring

Area code for the merchant's additional_phone number

additional_phonestring

Additional phone number of the merchant

addressstring

Merchant address

area_codestring

Area code of the merchant's phone number.

brand_namestring

Merchant's brand name

citystring

Merchant city

city_codestring

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.

complementary_addressstring

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

contactstring

Name of a merchant representative

countrystring

Merchant address country name

document_numberstring

Merchant's <<glossary:document number>>

emailstring

Merchant's email address

external_codestring

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

marketplace_idinteger

Marketplace ID from Pismo Control Center

municipal_registrationstring

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

namestring

Merchant's name

neighborhoodstring

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

numberinteger

Merchant's address number

phonestring

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

program_idinteger

Program ID for the merchant account

statestring

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

zip_codestring

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

metadataobject

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.

Example request

{
  "origin": "FILE",
  "migration": {
    "id": "5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21",
    "version_date": "2021-09-13T19:54:41Z"
  },
  "additional_area_code": "763",
  "additional_phone": "555-5678",
  "address": "1000 Main Street San Francisco, CA 94105",
  "area_code": "415",
  "brand_name": "Merchant Brand",
  "city": "San Francisco",
  "city_code": "3550308",
  "complementary_address": "Suite 500",
  "contact": "John Doe",
  "country": "United States",
  "document_number": "54938832011",
  "email": "merchantbrand@gmail.com",
  "external_code": "1234567890",
  "marketplace_id": 3213,
  "municipal_registration": "347219312",
  "name": "Lombard Street Coffee & Tea",
  "neighborhood": "Castle",
  "number": 312,
  "phone": "99845767",
  "state": "CA",
  "zip_code": "94105",
  "creditor": {
    "name": "Merchant name",
    "advancement_fee": 15.4,
    "discount_rate": 11.5,
    "maximum_advancement_percentage": 10.5,
    "crediting_method": "ACCOUNT"
  },
  "metadata": {
    "merchant_form_on_us": false,
    "key2": "value2"
  }
}

Response

Accepted

Changes

No recorded changes to this operation across all 1 revision of this API.