Merchant created
Type: object
Domain: merchants
Event: merchant_created
Version: 1
id required
Title: Merchant identifier
Description: This field contains the identifier of the merchant created.
Type: integer
Example:
1
document_number required
Title: Document number
Description: This field contains the document number of the merchant created.
Type: null or string
Example:
null
40533164000107
brand_name
Title: Brand name
Description: This field contains the brand name of the merchant created.
Type: null or string
Example:
null
Super Merchant
name required
Title: Merchant name
Description: This field contains the name of the merchant created.
Type: null or string
Example:
null
Super Merchant LTDA
municipal_registration
Title: Municipal registration
Description: The municipal registration of merchant
Type: null or string
Example:
null
ISENTO
creditor_id
Title: Creditor identifier
Description: This field identifies the creditor related to merchant created.
Type: null or integer
Example:
5
program_id
Title: Program identifier
Description: This field identifies program in which the merchant was registered in.
Type: null or integer
Example:
null
123
account_id
Title: Account identifier
Description: This field identifies account related to the merchant created.
Type: null or integer
Example:
null
1234
external_id
Title: External merchant identifier
Description: This field contains the identifier provided by an external system for the the merchant.
Type: null or string
Example:
null
2312312
external_code
Title: Business category external code
Description: This field contains the external code for the merchant business category.
Type: null or string
Example:
null
1213
status
Title: Status
Description: This field contains the current merchant status.
Type: null or string
Example:
null
PENDING
ACTIVE
address
Title: Address
Type: objectaddress
Title: Address
Description: This field contains the address of the merchant.
Type: null or string
Example:
null
Doctor Douglas Adams Streetnumber
Title: Number
Description: This field contains number that composes the address.
Type: null or integer
Example:
null
42complementary_address
Title: Complementary address
Description: This field contains information that complements the address.
Type: null or string
Example:
null
2nd floorneighborhood
Title: Neighborhood
Description: This field contains the name of the neighborhood.
Type: null or string
Example:
null
Vila Olímpiazip_code
Title: Zip code
Description: This field contains the zip code of the merchant's address.
Type: null or string
Example:
null
04545050city
Title: City
Description: This field contains the city where the merchant is located.
Type: null or string
Example:
null
São Paulostate
Title: State
Description: This field contains the state where the merchant's city is located.
Type: null or string
Example:
null
SPcountry
Title: Country
Description: This field contains the merchant country.
Type: null or string
Example:
null
Brazilcity_code
Title: City code
Description: This field contains the national code that identifies a city.
Type: null or string
Example:
null
12312321
contact
Title: Contact
Type: objectcontact
Title: Contact name
Description: This field contains the merchant contact name.
Type: null or string
Example:
null
ACTIVEarea_code
Title: Area code
Description: The area code of the merchant phone.
Type: null or string
Example:
null
11phone
Title: Phone
Description: This field contains merchant phone number.
Type: null or string
Example:
null
27912678additional_area_code
Title: Additional area code
Description: This field contains area code for an additional phone number.
Type: null or string
Example:
null
47additional_phone
Title: Additional phone
Description: This field contains an additional phone number.
Type: null or string
Example:
null
27912678email required
Title: E-mail
Description: This field contains the merchant e-mail address.
Type: string
Example:
[email protected]
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "Merchant created",
"required": [
"id",
"name",
"document_number"
],
"properties": {
"id": {
"$id": "#/properties/id",
"type": [
"integer"
],
"title": "Merchant identifier",
"description": "This field contains the identifier of the merchant created.",
"examples": [
1
]
},
"document_number": {
"$id": "#/properties/document_number",
"type": [
"null",
"string"
],
"title": "Document number",
"description": "This field contains the document number of the merchant created.",
"examples": [
null,
"40533164000107"
]
},
"brand_name": {
"$id": "#/properties/brand_name",
"type": [
"null",
"string"
],
"title": "Brand name",
"description": "This field contains the brand name of the merchant created.",
"examples": [
null,
"Super Merchant"
]
},
"name": {
"$id": "#/properties/name",
"type": [
"null",
"string"
],
"title": "Merchant name",
"description": "This field contains the name of the merchant created.",
"examples": [
null,
"Super Merchant LTDA"
]
},
"municipal_registration": {
"$id": "#/properties/municipal_registration",
"type": [
"null",
"string"
],
"title": "Municipal registration",
"description": "The municipal registration of merchant",
"examples": [
null,
"ISENTO"
]
},
"creditor_id": {
"$id": "#/properties/creditor_id",
"type": [
"null",
"integer"
],
"title": "Creditor identifier",
"description": "This field identifies the creditor related to merchant created.",
"examples": [
5
]
},
"program_id": {
"$id": "#/properties/program_id",
"type": [
"null",
"integer"
],
"title": "Program identifier",
"description": "This field identifies program in which the merchant was registered in.",
"examples": [
null,
123
]
},
"account_id": {
"$id": "#/properties/account_id",
"type": [
"null",
"integer"
],
"title": "Account identifier",
"description": "This field identifies account related to the merchant created.",
"examples": [
null,
1234
]
},
"external_id": {
"$id": "#/properties/external_id",
"type": [
"null",
"string"
],
"title": "External merchant identifier",
"description": "This field contains the identifier provided by an external system for the the merchant.",
"examples": [
null,
"2312312"
]
},
"external_code": {
"$id": "#/properties/external_code",
"type": [
"null",
"string"
],
"title": "Business category external code",
"description": "This field contains the external code for the merchant business category.",
"examples": [
null,
"1213"
]
},
"status": {
"$id": "#/properties/status",
"type": [
"null",
"string"
],
"title": "Status",
"description": "This field contains the current merchant status.",
"examples": [
null,
"PENDING",
"ACTIVE"
]
},
"address": {
"$id": "#/properties/address",
"type": "object",
"title": "Address",
"required": [],
"properties": {
"address": {
"$id": "#/properties/address",
"type": [
"null",
"string"
],
"title": "Address",
"description": "This field contains the address of the merchant.",
"examples": [
null,
"Doctor Douglas Adams Street"
]
},
"number": {
"$id": "#/properties/number",
"type": [
"null",
"integer"
],
"title": "Number",
"description": "This field contains number that composes the address.",
"examples": [
null,
42
]
},
"complementary_address": {
"$id": "#/properties/complementary_address",
"type": [
"null",
"string"
],
"title": "Complementary address",
"description": "This field contains information that complements the address.",
"examples": [
null,
"2nd floor"
]
},
"neighborhood": {
"$id": "#/properties/neighborhood",
"type": [
"null",
"string"
],
"title": "Neighborhood",
"description": "This field contains the name of the neighborhood.",
"examples": [
null,
"Vila Ol\u00edmpia"
]
},
"zip_code": {
"$id": "#/properties/zip_code",
"type": [
"null",
"string"
],
"title": "Zip code",
"description": "This field contains the zip code of the merchant's address.",
"examples": [
null,
"04545050"
]
},
"city": {
"$id": "#/properties/city",
"type": [
"null",
"string"
],
"title": "City",
"description": "This field contains the city where the merchant is located.",
"examples": [
null,
"S\u00e3o Paulo"
]
},
"state": {
"$id": "#/properties/state",
"type": [
"null",
"string"
],
"title": "State",
"description": "This field contains the state where the merchant's city is located.",
"examples": [
null,
"SP"
]
},
"country": {
"$id": "#/properties/country",
"type": [
"null",
"string"
],
"title": "Country",
"description": "This field contains the merchant country.",
"examples": [
null,
"Brazil"
]
},
"city_code": {
"$id": "#/properties/city_code",
"type": [
"null",
"string"
],
"title": "City code",
"description": "This field contains the national code that identifies a city.",
"examples": [
null,
"12312321"
]
}
}
},
"contact": {
"$id": "#/properties/contact",
"type": "object",
"title": "Contact",
"required": [
"email"
],
"properties": {
"contact": {
"$id": "#/properties/contact",
"type": [
"null",
"string"
],
"title": "Contact name",
"description": "This field contains the merchant contact name.",
"examples": [
null,
"ACTIVE"
]
},
"area_code": {
"$id": "#/properties/area_code",
"type": [
"null",
"string"
],
"title": "Area code",
"description": "The area code of the merchant phone.",
"examples": [
null,
"11"
]
},
"phone": {
"$id": "#/properties/phone",
"type": [
"null",
"string"
],
"title": "Phone",
"description": "This field contains merchant phone number.",
"examples": [
null,
"27912678"
]
},
"additional_area_code": {
"$id": "#/properties/additional_area_code",
"type": [
"null",
"string"
],
"title": "Additional area code",
"description": "This field contains area code for an additional phone number.",
"examples": [
null,
"47"
]
},
"additional_phone": {
"$id": "#/properties/additional_phone",
"type": [
"null",
"string"
],
"title": "Additional phone",
"description": "This field contains an additional phone number.",
"examples": [
null,
"27912678"
]
},
"email": {
"$id": "#/properties/email",
"type": "string",
"title": "E-mail",
"description": "This field contains the merchant e-mail address.",
"examples": [
"[email protected]"
]
}
}
}
}
}
{
"id": 1,
"document_number": "40533164000107",
"brand_name": "Super Merchant",
"name": "Super Merchant LTDA",
"municipal_registration": "ISENTO",
"creditor_id": 5,
"program_id": 123,
"account_id": 1234,
"external_id": "2312312",
"external_code": "1213",
"status": "PENDING",
"address": {
"address": "Doctor Douglas Adams Street",
"number": 42,
"complementary_address": "2nd floor",
"neighborhood": "Vila Ol\u00edmpia",
"zip_code": "04545050",
"city": "S\u00e3o Paulo",
"state": "SP",
"country": "Brazil",
"city_code": "12312321"
},
"contact": {
"contact": "ACTIVE",
"area_code": "11",
"phone": "27912678",
"additional_area_code": "47",
"additional_phone": "27912678",
"email": "[email protected]"
}
}
Updated 21 days ago