EC operation failed

Failed EC operation event

Type: object
Domain: depositary
Event: commercial_establishment_failure
Version: 1

corporate_name

Title: Corporate name
Description: Corporate name given by the customer
Type: string
Example:
Pismo

document_type

Title: Document type
Description: Document type of EC registration. [1=CPF] [2=CNPJ]
Type: integer
Example:
1
2

merchant_document_number

Title: Merchant document number
Description: Merchant document number of EC register
Type: string
Example:
23221396000100

classification_type

Title: Classification type
Description: Classification is a type of EC given by the client. [1=merchant] [2=sub-acquirer]
Type: integer
Example:
1
2

situation_type

Title: Situation type
Description: Situation represents a state of EC. [1=ACTIVE] [2=INACTIVE] [3=SUSPENDED]
Type: integer
Example:
1
2
3

settlement_blocking

Title: Settlement blocking
Description: Settlement blocking flag of EC. [0=NO] [1=YES]
Type: integer
Example:
1
2

accreditation_date

Title: Accreditation date
Description: Refers to the date that the EC was effectively registered
Type: string
Format: date
Example:
2020-12-01

mcc_code

Title: MCC code
Description: Commercial Establishment activity code
Type: string
Example:
3020

acquirer_document_number

Title: Acquirer document number
Description: Acquirer document number of EC register
Type: string
Example:
11907732000186

external_id

Title: External Id
Description: External Id is a identifier given by the customer
Type: string
Example:
11907732000186

payment_arrangement

Type: array

message required

Title: Error message
Description: Message refers to the process of Commercial Establishment
Type: string
Example:
Commercial Establishment invalid

operation_type required

Title: Operation Type
Description: Operation Type identifiers which type is this event
Type: string
Example:
CREATE
UPDATE

operation_status required

Title: Operation Status
Description: Operation Status identifiers which status is this event
Type: string
Example:
FAILURE

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "EC operation failed",
    "description": "Failed EC operation event",
    "required": [
        "message",
        "operation_type",
        "operation_status"
    ],
    "properties": {
        "corporate_name": {
            "type": "string",
            "title": "Corporate name",
            "description": "Corporate name given by the customer",
            "examples": [
                "Pismo"
            ]
        },
        "document_type": {
            "type": "integer",
            "title": "Document type",
            "description": "Document type of EC registration. [1=CPF] [2=CNPJ]",
            "examples": [
                1,
                2
            ]
        },
        "merchant_document_number": {
            "type": "string",
            "title": "Merchant document number",
            "description": "Merchant document number of EC register",
            "examples": [
                "23221396000100"
            ]
        },
        "classification_type": {
            "type": "integer",
            "title": "Classification type",
            "description": "Classification is a type of EC given by the client. [1=merchant] [2=sub-acquirer]",
            "examples": [
                1,
                2
            ]
        },
        "situation_type": {
            "type": "integer",
            "title": "Situation type",
            "description": "Situation represents a state of EC. [1=ACTIVE] [2=INACTIVE] [3=SUSPENDED]",
            "examples": [
                1,
                2,
                3
            ]
        },
        "settlement_blocking": {
            "type": "integer",
            "title": "Settlement blocking",
            "description": "Settlement blocking flag of EC. [0=NO] [1=YES]",
            "examples": [
                1,
                2
            ]
        },
        "accreditation_date": {
            "type": "string",
            "title": "Accreditation date",
            "description": "Refers to the date that the EC was effectively registered",
            "format": "date",
            "examples": [
                "2020-12-01"
            ]
        },
        "mcc_code": {
            "type": "string",
            "title": "MCC code",
            "description": "Commercial Establishment activity code",
            "examples": [
                "3020"
            ]
        },
        "acquirer_document_number": {
            "type": "string",
            "title": "Acquirer document number",
            "description": "Acquirer document number of EC register",
            "examples": [
                "11907732000186"
            ]
        },
        "external_id": {
            "type": "string",
            "title": "External Id",
            "description": "External Id is a identifier given by the customer",
            "examples": [
                "11907732000186"
            ]
        },
        "payment_arrangement": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "title": "Payment arrangement",
            "description": "User registration identifiers in the flag",
            "examples": [
                "ECC",
                "ECD"
            ]
        },
        "message": {
            "type": "string",
            "title": "Error message",
            "description": "Message refers to the process of Commercial Establishment",
            "examples": [
                "Commercial Establishment invalid"
            ]
        },
        "operation_type": {
            "type": "string",
            "title": "Operation Type",
            "description": "Operation Type identifiers which type is this event",
            "examples": [
                "CREATE",
                "UPDATE"
            ]
        },
        "operation_status": {
            "type": "string",
            "title": "Operation Status",
            "description": "Operation Status identifiers which status is this event",
            "examples": [
                "FAILURE"
            ]
        }
    }
}

Updated 4 days ago