Marketplace created

Type: object
Domain: marketplace
Event: marketplace_created
Version: 1

|
id

Title: The marketplace id
Description: This field represents the marketplace id
Type: integer
Example:
null
1

document_number required

Title: The marketplace document number
Description: This field represents the marketplace document number
Type: string
Example:
42845458000191

registration

Title: The marketplace registration
Description: This field represents the marketplace municipal registration
Type: string
Example:
null
123.456.789

registration2

Title: The marketplace second registration
Description: This field represents the marketplace another registration
Type: string
Example:
null
123.456.789

brand_name required

Title: The marketplace brand name
Description: This field represents the marketplace brand name (Nome Fantasia)
Type: string
Example:
Marketplace

marketplace_name required

Title: The marketplace name
Description: This field represents the marketplace name (Razão Social)
Type: string
Example:
Marketplace

address

Title: The marketplace address
Description: This field represents the marketplace address
Type: object

street

Title: The marketplace address street
Description: This field represents the marketplace address street
Type: string
Example:
null
Rua das Palmeiras

number

Title: The marketplace address number
Description: This field represents the marketplace address number
Type: integer
Example:
null
1

complementary_address

Title: The marketplace complementary address
Description: This field represents the marketplace complementary address. Second line of address (if needed)
Type: string
Example:
null
Near to somewhere.

neighborhood

Title: The marketplace address neighborhood
Description: This field represents the marketplace address neighborhood
Type: string
Example:
null
Neighborhood

zip_code

Title: The marketplace address zip code
Description: This field represents the marketplace address postal code
Type: string
Example:
null
12345-678

city

Title: The marketplace address city
Description: This field represents the marketplace address city
Type: string
Example:
null
São Paulo

state

Title: The marketplace address state
Description: This field represents the marketplace address state
Type: string
Example:
null
SP

country

Title: The marketplace address country
Description: This field represents the marketplace address country
Type: string
Example:
null
Brazil

contact

Title: The marketplace contact
Description: This field represents the marketplace contact
Type: object

name

Title: The marketplace contact name
Description: This field represents the marketplace contact name
Type: string
Example:
null
Marketplace Name

email required

Title: The marketplace contact email
Description: This field represents the marketplace contact email
Type: string
Example:
[email protected]

phone_number

Title: The marketplace contact phone number
Description: This field represents the marketplace contact phone number
Type: string
Example:
null
111234567890

additional_phone_number

Title: The marketplace contact additional phone number
Description: This field represents the marketplace contact additional phone number
Type: string
Example:
null
111234567890

days_to_payment

Title: The marketplace days to payment
Description: This field represents the marketplace days to payment
Type: integer
Example:
null
1

acquirer_mdr

Title: The marketplace acquirer mdr
Description: This field represents the marketplace acquirer mdr
Type: integer
Example:
null
1

incremental_mdr

Title: The marketplace incremental mdr
Description: This field represents the marketplace incremental mdr
Type: integer
Example:
null
1

bank_account

Title: The marketplace bank account
Description: This field represents the marketplace bank account
Type: object

bank_id

Title: The marketplace bank account bank id
Description: This field represents the marketplace bank account bank id
Type: integer
Example:
null
1

bank_agency

Title: The marketplace bank account agency
Description: This field represents the marketplace bank account agency
Type: string
Example:
null
1234

bank_agency_vd

Title: The marketplace bank account agency verification digit
Description: This field represents the marketplace bank account agency verification digit. In some cases, this can be a letter
Type: string
Example:
null
X

bank_account

Title: The marketplace bank account
Description: This field represents the marketplace bank account
Type: string
Example:
null
1234

bank_account_vd

Title: The marketplace bank account verification digit
Description: This field represents the marketplace bank account verification digit
Type: string
Example:
null
1

cedente_id

Title: The marketplace cedente id
Description: This field represents the marketplace cedente id
Type: integer
Example:
null
1

financial_email

Title: The marketplace financial email
Description: This field represents the marketplace financial email
Type: string
Example:
null
[email protected]

chargeback_management

Title: The marketplace chargeback management
Description: This field represents the marketplace chargeback management
Type: string
Example:
null
Marketplace

org_as_sub_acquirer

Title: The marketplace org as sub acquirer
Description: This field represents the marketplace org as sub acquirer. 0 = false and 1 = true. If true, Org pays marketplace and merchants.
Type: integer
Example:
null
1

external_id

Title: External identifier
Description: This field represents the marketplace identifier in an external system
Type: string or null
Example:
null
null
123
123AB

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Marketplace created",
    "required": [
        "brand_name",
        "marketplace_name",
        "document_number"
    ],
    "properties": {
        "id": {
            "$id": "#/properties/id",
            "type": "integer",
            "title": "The marketplace id",
            "description": "This field represents the marketplace id",
            "examples": [
                null,
                1
            ]
        },
        "document_number": {
            "$id": "#/properties/document_number",
            "type": "string",
            "title": "The marketplace document number",
            "description": "This field represents the marketplace document number",
            "examples": [
                "42845458000191"
            ]
        },
        "registration": {
            "$id": "#/properties/registration",
            "type": "string",
            "title": "The marketplace registration",
            "description": "This field represents the marketplace municipal registration",
            "examples": [
                null,
                "123.456.789"
            ]
        },
        "registration2": {
            "$id": "#/properties/registration2",
            "type": "string",
            "title": "The marketplace second registration",
            "description": "This field represents the marketplace another registration",
            "examples": [
                null,
                "123.456.789"
            ]
        },
        "brand_name": {
            "$id": "#/properties/brand_name",
            "type": "string",
            "title": "The marketplace brand name",
            "description": "This field represents the marketplace brand name (Nome Fantasia)",
            "examples": [
                "Marketplace"
            ]
        },
        "marketplace_name": {
            "$id": "#/properties/marketplace_name",
            "type": "string",
            "title": "The marketplace name",
            "description": "This field represents the marketplace name (Raz\u00e3o Social)",
            "examples": [
                "Marketplace"
            ]
        },
        "address": {
            "$id": "#/properties/address",
            "type": "object",
            "title": "The marketplace address",
            "description": "This field represents the marketplace address",
            "required": [],
            "properties": {
                "street": {
                    "$id": "#/properties/address/street",
                    "type": "string",
                    "title": "The marketplace address street",
                    "description": "This field represents the marketplace address street",
                    "examples": [
                        null,
                        "Rua das Palmeiras"
                    ]
                },
                "number": {
                    "$id": "#/properties/address/number",
                    "type": "integer",
                    "title": "The marketplace address number",
                    "description": "This field represents the marketplace address number",
                    "examples": [
                        null,
                        1
                    ]
                },
                "complementary_address": {
                    "$id": "#/properties/address/id",
                    "type": "string",
                    "title": "The marketplace complementary address",
                    "description": "This field represents the marketplace complementary address. Second line of address (if needed)",
                    "examples": [
                        null,
                        "Near to somewhere."
                    ]
                },
                "neighborhood": {
                    "$id": "#/properties/address/neighborhood",
                    "type": "string",
                    "title": "The marketplace address neighborhood",
                    "description": "This field represents the marketplace address neighborhood",
                    "examples": [
                        null,
                        "Neighborhood"
                    ]
                },
                "zip_code": {
                    "$id": "#/properties/address/zip_code",
                    "type": "string",
                    "title": "The marketplace address zip code",
                    "description": "This field represents the marketplace address postal code",
                    "examples": [
                        null,
                        "12345-678"
                    ]
                },
                "city": {
                    "$id": "#/properties/address/city",
                    "type": "string",
                    "title": "The marketplace address city",
                    "description": "This field represents the marketplace address city",
                    "examples": [
                        null,
                        "S\u00e3o Paulo"
                    ]
                },
                "state": {
                    "$id": "#/properties/address/state",
                    "type": "string",
                    "title": "The marketplace address state",
                    "description": "This field represents the marketplace address state",
                    "examples": [
                        null,
                        "SP"
                    ]
                },
                "country": {
                    "$id": "#/properties/address/country",
                    "type": "string",
                    "title": "The marketplace address country",
                    "description": "This field represents the marketplace address country",
                    "examples": [
                        null,
                        "Brazil"
                    ]
                }
            }
        },
        "contact": {
            "$id": "#/properties/contact",
            "type": "object",
            "title": "The marketplace contact",
            "description": "This field represents the marketplace contact",
            "required": [
                "email"
            ],
            "properties": {
                "name": {
                    "$id": "#/properties/contact/name",
                    "type": "string",
                    "title": "The marketplace contact name",
                    "description": "This field represents the marketplace contact name",
                    "examples": [
                        null,
                        "Marketplace Name"
                    ]
                },
                "email": {
                    "$id": "#/properties/contact/email",
                    "type": "string",
                    "title": "The marketplace contact email",
                    "description": "This field represents the marketplace contact email",
                    "examples": [
                        "[email protected]"
                    ]
                },
                "phone_number": {
                    "$id": "#/properties/contact/phone_number",
                    "type": "string",
                    "title": "The marketplace contact phone number",
                    "description": "This field represents the marketplace contact phone number",
                    "examples": [
                        null,
                        "111234567890"
                    ]
                },
                "additional_phone_number": {
                    "$id": "#/properties/contact/additional_phone_number",
                    "type": "string",
                    "title": "The marketplace contact additional phone number",
                    "description": "This field represents the marketplace contact additional phone number",
                    "examples": [
                        null,
                        "111234567890"
                    ]
                }
            }
        },
        "days_to_payment": {
            "$id": "#/properties/days_to_payment",
            "type": "integer",
            "title": "The marketplace days to payment",
            "description": "This field represents the marketplace days to payment",
            "examples": [
                null,
                1
            ]
        },
        "acquirer_mdr": {
            "$id": "#/properties/acquirer_mdr",
            "type": "integer",
            "title": "The marketplace acquirer mdr",
            "description": "This field represents the marketplace acquirer mdr",
            "examples": [
                null,
                1
            ]
        },
        "incremental_mdr": {
            "$id": "#/properties/incremental_mdr",
            "type": "integer",
            "title": "The marketplace incremental mdr",
            "description": "This field represents the marketplace incremental mdr",
            "examples": [
                null,
                1
            ]
        },
        "bank_account": {
            "$id": "#/properties/bank_account",
            "type": "object",
            "title": "The marketplace bank account",
            "description": "This field represents the marketplace bank account",
            "properties": {
                "bank_id": {
                    "$id": "#/properties/bank_account/bank_id",
                    "type": "integer",
                    "title": "The marketplace bank account bank id",
                    "description": "This field represents the marketplace bank account bank id",
                    "examples": [
                        null,
                        1
                    ]
                },
                "bank_agency": {
                    "$id": "#/properties/bank_account/bank_agency",
                    "type": "string",
                    "title": "The marketplace bank account agency",
                    "description": "This field represents the marketplace bank account agency",
                    "examples": [
                        null,
                        "1234"
                    ]
                },
                "bank_agency_vd": {
                    "$id": "#/properties/bank_account/bank_agency_vd",
                    "type": "string",
                    "title": "The marketplace bank account agency verification digit",
                    "description": "This field represents the marketplace bank account agency verification digit. In some cases, this can be a letter",
                    "examples": [
                        null,
                        "X"
                    ]
                },
                "bank_account": {
                    "$id": "#/properties/bank_account/bank_account",
                    "type": "string",
                    "title": "The marketplace bank account",
                    "description": "This field represents the marketplace bank account",
                    "examples": [
                        null,
                        "1234"
                    ]
                },
                "bank_account_vd": {
                    "$id": "#/properties/bank_account/bank_account_vd",
                    "type": "string",
                    "title": "The marketplace bank account verification digit",
                    "description": "This field represents the marketplace bank account verification digit",
                    "examples": [
                        null,
                        "1"
                    ]
                }
            }
        },
        "cedente_id": {
            "$id": "#/properties/cedente_id",
            "type": "integer",
            "title": "The marketplace cedente id",
            "description": "This field represents the marketplace cedente id",
            "examples": [
                null,
                1
            ]
        },
        "financial_email": {
            "$id": "#/properties/financial_email",
            "type": "string",
            "title": "The marketplace financial email",
            "description": "This field represents the marketplace financial email",
            "examples": [
                null,
                "[email protected]"
            ]
        },
        "chargeback_management": {
            "$id": "#/properties/chargeback_management",
            "type": "string",
            "title": "The marketplace chargeback management",
            "description": "This field represents the marketplace chargeback management",
            "examples": [
                null,
                "Marketplace"
            ]
        },
        "org_as_sub_acquirer": {
            "$id": "#/properties/org_as_sub_acquirer",
            "type": "integer",
            "title": "The marketplace org as sub acquirer",
            "description": "This field represents the marketplace org as sub acquirer. 0 = false and 1 = true. If true, Org pays marketplace and merchants.",
            "examples": [
                null,
                1
            ]
        },
        "external_id": {
            "$id": "#/properties/external_id",
            "type": [
                "string",
                "null"
            ],
            "title": "External identifier",
            "description": "This field represents the marketplace identifier in an external system",
            "examples": [
                null,
                "",
                "123",
                "123AB"
            ]
        }
    }
}