Merchant settlement created

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

|
id required

Title: The merchant settlement identifier
Description: This field identifies the merchant transaction created.
Type: string
Example:
null
9d451fb5-8968-45bf-8cdd-37e05aaaf102

merchant_id required

Title: The merchant identifier
Description: This field identifies the merchant related to transaction.
Type: integer
Example:
4

authorization_id

Title: The authorization identifier
Description: This field identifies the authorization identifier related to the settlement.
Type: null or integer
Example:
null
2

settlement_date required

Title: The date of settlement
Description: This field identifies the date when the settlement occurred.
Type: string
Format: date
Example:
2021-03-25

net_amount required

Title: The net amount of the settlement
Description: This field identifies the settlement net amount.
Type: number
Example:
100.0

gross_amount required

Title: The gross amount of the settlement
Description: This field identifies the settlement gross amount.
Type: number
Example:
100.0

mdr_amount

Title: The total MDR amount of the settlement
Description: This field identifies the amount of MDR payed in this settlement.
Type: null or number
Example:
null
null
10.0

transaction_fee

Title: The total fee of the settlement
Description: This field identifies the fee payed in this settlement.
Type: null or number
Example:
null
null
10.0

mdr_tax

Title: The total MDR tax of the settlement
Description: This field identifies the MDR tax payed in this settlement.
Type: null or number
Example:
null
null
10.0

processing_code required

Title: The processing code of the settlement.
Description: This field identifies the processing code related to the settlement.
Type: string
Example:
001234

settlement_type

Title: The settlement type.
Description: This field identifies the type related to the settlement.
Type: string
Example:
INDIVIDUALIZED
CENTRALIZED

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Merchant settlement created",
    "required": [
        "id",
        "merchant_id",
        "settlement_date",
        "net_amount",
        "gross_amount",
        "processing_code"
    ],
    "properties": {
        "id": {
            "$id": "#/properties/id",
            "type": [
                "string"
            ],
            "title": "The merchant settlement identifier",
            "description": "This field identifies the merchant transaction created.",
            "examples": [
                null,
                "9d451fb5-8968-45bf-8cdd-37e05aaaf102"
            ]
        },
        "merchant_id": {
            "$id": "#/properties/merchant_id",
            "type": "integer",
            "title": "The merchant identifier",
            "description": "This field identifies the merchant related to transaction.",
            "examples": [
                4
            ]
        },
        "authorization_id": {
            "$id": "#/properties/authorization_id",
            "type": [
                "null",
                "integer"
            ],
            "title": "The authorization identifier",
            "description": "This field identifies the authorization identifier related to the settlement.",
            "examples": [
                null,
                2
            ]
        },
        "settlement_date": {
            "$id": "#/properties/settlement_date",
            "type": "string",
            "format": "date",
            "title": "The date of settlement",
            "description": "This field identifies the date when the settlement occurred.",
            "examples": [
                "2021-03-25"
            ]
        },
        "net_amount": {
            "$id": "#/properties/net_amount",
            "type": "number",
            "title": "The net amount of the settlement",
            "description": "This field identifies the settlement net amount.",
            "examples": [
                100.0
            ]
        },
        "gross_amount": {
            "$id": "#/properties/gross_amount",
            "type": "number",
            "title": "The gross amount of the settlement",
            "description": "This field identifies the settlement gross amount.",
            "examples": [
                100.0
            ]
        },
        "mdr_amount": {
            "$id": "#/properties/mdr_amount",
            "type": [
                "null",
                "number"
            ],
            "title": "The total MDR amount of the settlement",
            "description": "This field identifies the amount of MDR payed in this settlement.",
            "examples": [
                null,
                0.0,
                10.0
            ]
        },
        "transaction_fee": {
            "$id": "#/properties/transaction_fee",
            "type": [
                "null",
                "number"
            ],
            "title": "The total fee of the settlement",
            "description": "This field identifies the fee payed in this settlement.",
            "examples": [
                null,
                0.0,
                10.0
            ]
        },
        "mdr_tax": {
            "$id": "#/properties/mdr_tax",
            "type": [
                "null",
                "number"
            ],
            "title": "The total MDR tax of the settlement",
            "description": "This field identifies the MDR tax payed in this settlement.",
            "examples": [
                null,
                0.0,
                10.0
            ]
        },
        "processing_code": {
            "$id": "#/properties/processing_code",
            "type": "string",
            "title": "The processing code of the settlement.",
            "description": "This field identifies the processing code related to the settlement.",
            "examples": [
                "001234"
            ]
        },
        "settlement_type": {
            "$id": "#/properties/settlement_type",
            "type": "string",
            "title": "The settlement type.",
            "description": "This field identifies the type related to the settlement.",
            "examples": [
                "INDIVIDUALIZED",
                "CENTRALIZED"
            ]
        }
    }
}
{
    "id": "9d451fb5-8968-45bf-8cdd-37e05aaaf102",
    "merchant_id": 4,
    "authorization_id": 2,
    "settlement_date": "2021-03-25",
    "net_amount": 100.0,
    "gross_amount": 100.0,
    "mdr_amount": 0.0,
    "transaction_fee": 0.0,
    "mdr_tax": 0.0,
    "processing_code": "001234",
    "settlement_type": "INDIVIDUALIZED"
}