Merchant terminal created

Type: object
Domain: merchants
Event: merchant_terminal_created
Version: 1

|
id required

Title: The merchant terminal id
Description: This field represents the merchant terminal
Type: integer
Example:
1

merchant_id required

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

external_terminal_id

Title: The merchant terminal external id
Description: Identification of the merchant's terminal assigned in the 1FPay customer system. For 1FPay, this is just registration information
Type: null or string
Example:
null
14578

terminal_type required

Title: The merchant terminal type
Description: Type of technology assigned to the commercial establishment's terminal: [1] ECOMMERCE: e-commerce transaction sales terminal (internet sales); [2] POS: individual physical sales terminal; [3] TEF: centralized sales terminal integrated with the sales system; [4] MOBILE: sales terminal using cell phone; [5] PINPAD: gadget for capturing transactions and password, integrated into a device or computer to act as a sales terminal; [6] URA_MOTO: sales terminal via call center (MOTO = MAIL ORDER - TELEPHONE ORDER)
Type: integer
Example:
1
2
3
4
5
6

terminal_brand required

Title: The merchant terminal brand
Description: Merchant terminal brand type
Type: string
Example:
VERIFONE

terminal_model required

Title: The merchant terminal model
Description: Merchant terminal model type
Type: string
Example:
ABC123

terminal_protocol

Title: The merchant terminal protocol
Description: Type of protocol operated by the merchant terminal
Type: null or string
Example:
null
TCPIP

terminal_installation_date

Title: The merchant terminal installation date
Description: Date of installation of the terminal in the commercial establishment
Type: null or string
Example:
null
2023-03-24

own_terminal_flag required

Title: The merchant own terminal flag
Description: Flag to indicate the commercial establishment owns the terminal
Type: boolean
Example:
false
true

terminal_serial_number

Title: The merchant terminal serial number
Description: Merchant terminal serial number
Type: null or string
Example:
null
A9CB97JKO986L

terminal_asset_control

Title: The merchant terminal asset control
Description: Merchant terminal asset control number
Type: null or string
Example:
null
2019-0678

terminal_status required

Title: The merchant terminal status
Description: State to indicate the status of the merchant's terminal: [1] REQUESTED: Indicates whether the terminal was requested; [2] IN TRANSIT: Indicates whether the terminal is in transit; [3] ACTIVE: Indicates whether the terminal is active; [4] INACTIVE: Indicates if the terminal is inactive; [5] REPLACED: Indicates if the terminal has been replaced; [6] COLLECTED: Indicates whether the terminal has been collected
Type: integer
Example:
1
2
3
4
5
6

created_at

Title: The merchant terminal created date
Description: This field represents the merchant terminal created date
Type: null or string
Example:
null
2023-03-24T19:35:16Z

updated_at

Title: The merchant terminal updated date
Description: This field represents the merchant terminal updated date
Type: null or string
Example:
null
2023-03-24T19:35:16Z

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Merchant terminal created",
    "required": [
        "id",
        "merchant_id",
        "terminal_type",
        "terminal_brand",
        "terminal_model",
        "own_terminal_flag",
        "terminal_status"
    ],
    "properties": {
        "id": {
            "$id": "#/properties/id",
            "type": "integer",
            "title": "The merchant terminal id",
            "description": "This field represents the merchant terminal",
            "examples": [
                1
            ]
        },
        "merchant_id": {
            "$id": "#/properties/merchant_id",
            "type": "integer",
            "title": "The merchant id",
            "description": "This field represents the merchant",
            "examples": [
                1
            ]
        },
        "external_terminal_id": {
            "$id": "#/properties/external_terminal_id",
            "type": [
                "null",
                "string"
            ],
            "title": "The merchant terminal external id",
            "description": "Identification of the merchant's terminal assigned in the 1FPay customer system. For 1FPay, this is just registration information",
            "examples": [
                null,
                "14578"
            ]
        },
        "terminal_type": {
            "$id": "#/properties/terminal_type",
            "type": "integer",
            "title": "The merchant terminal type",
            "description": "Type of technology assigned to the commercial establishment's terminal: [1] ECOMMERCE: e-commerce transaction sales terminal (internet sales); [2] POS: individual physical sales terminal; [3] TEF: centralized sales terminal integrated with the sales system; [4] MOBILE: sales terminal using cell phone; [5] PINPAD: gadget for capturing transactions and password, integrated into a device or computer to act as a sales terminal; [6] URA_MOTO: sales terminal via call center (MOTO = MAIL ORDER - TELEPHONE ORDER)",
            "examples": [
                1,
                2,
                3,
                4,
                5,
                6
            ]
        },
        "terminal_brand": {
            "$id": "#/properties/terminal_brand",
            "type": "string",
            "title": "The merchant terminal brand",
            "description": "Merchant terminal brand type",
            "examples": [
                "VERIFONE"
            ]
        },
        "terminal_model": {
            "$id": "#/properties/terminal_model",
            "type": "string",
            "title": "The merchant terminal model",
            "description": "Merchant terminal model type",
            "examples": [
                "ABC123"
            ]
        },
        "terminal_protocol": {
            "$id": "#/properties/terminal_protocol",
            "type": [
                "null",
                "string"
            ],
            "title": "The merchant terminal protocol",
            "description": "Type of protocol operated by the merchant terminal",
            "examples": [
                null,
                "TCPIP"
            ]
        },
        "terminal_installation_date": {
            "$id": "#/properties/terminal_installation_date",
            "type": [
                "null",
                "string"
            ],
            "title": "The merchant terminal installation date",
            "description": "Date of installation of the terminal in the commercial establishment",
            "examples": [
                null,
                "2023-03-24"
            ]
        },
        "own_terminal_flag": {
            "$id": "#/properties/own_terminal_flag",
            "type": "boolean",
            "default": "false",
            "title": "The merchant own terminal flag",
            "description": "Flag to indicate the commercial establishment owns the terminal",
            "examples": [
                false,
                true
            ]
        },
        "terminal_serial_number": {
            "$id": "#/properties/terminal_serial_number",
            "type": [
                "null",
                "string"
            ],
            "title": "The merchant terminal serial number",
            "description": "Merchant terminal serial number",
            "examples": [
                null,
                "A9CB97JKO986L"
            ]
        },
        "terminal_asset_control": {
            "$id": "#/properties/terminal_asset_control",
            "type": [
                "null",
                "string"
            ],
            "title": "The merchant terminal asset control",
            "description": "Merchant terminal asset control number",
            "examples": [
                null,
                "2019-0678"
            ]
        },
        "terminal_status": {
            "$id": "#/properties/terminal_status",
            "type": "integer",
            "title": "The merchant terminal status",
            "description": "State to indicate the status of the merchant's terminal: [1] REQUESTED: Indicates whether the terminal was requested; [2] IN TRANSIT: Indicates whether the terminal is in transit; [3] ACTIVE: Indicates whether the terminal is active; [4] INACTIVE: Indicates if the terminal is inactive; [5] REPLACED: Indicates if the terminal has been replaced; [6] COLLECTED: Indicates whether the terminal has been collected",
            "examples": [
                1,
                2,
                3,
                4,
                5,
                6
            ]
        },
        "created_at": {
            "$id": "#/properties/created_at",
            "type": [
                "null",
                "string"
            ],
            "title": "The merchant terminal created date",
            "description": "This field represents the merchant terminal created date",
            "examples": [
                null,
                "2023-03-24T19:35:16Z"
            ]
        },
        "updated_at": {
            "$id": "#/properties/updated_at",
            "type": [
                "null",
                "string"
            ],
            "title": "The merchant terminal updated date",
            "description": "This field represents the merchant terminal updated date",
            "examples": [
                null,
                "2023-03-24T19:35:16Z"
            ]
        }
    }
}
{
    "id": 1,
    "merchant_id": 1,
    "external_terminal_id": "14578",
    "terminal_type": 1,
    "terminal_brand": "VERIFONE",
    "terminal_model": "ABC123",
    "terminal_protocol": "TCPIP",
    "terminal_installation_date": "2023-03-24",
    "own_terminal_flag": false,
    "terminal_serial_number": "A9CB97JKO986L",
    "terminal_asset_control": "2019-0678",
    "terminal_status": 1,
    "created_at": "2023-03-24T19:35:16Z",
    "updated_at": "2023-03-24T19:35:16Z"
}